Skip to main content
API Explorer|API Explorer
Operations Management/Tenant Management (Plus)/Organization Operations
PUTOrganization OperationsSince 2.4.0SynchronousAuth Required

UpdateIAM2Organization

UpdateIAM2Organization

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    The resource UUID.

Body Fields

  • updateiam2organizationObjectRequired

    updateiam2organization request body object.

    • nameString

      Optional. The resource name.

    • descriptionString

      Optional. The detailed description of the resource.

    • parentUuidString

      Optional.

    • typeOrganizationType

      Optional.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoryIAM2OrganizationInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • parentUuidStringRequired

      父级资源UUID。

    • stateStateRequired

      See state.

      • nameStringRequired

        The resource name.

      • ordinalintRequired

        No description provided.

    • typeOrganizationTypeRequired

      See type.

      • nameStringRequired

        The resource name.

      • ordinalintRequired

        No description provided.

    • attributesListRequired

      See attributes.

      • organizationUuidStringRequired

        组织UUID。

      • uuidStringRequired

        The resource UUID.

      • nameStringRequired

        The resource name.

      • valueStringRequired

        字段值。

      • typeAttributeTypeRequired

        See type.

        • nameStringRequired

          The resource name.

        • ordinalintRequired

          No description provided.

Endpoint

PUT/zstack/v1/iam2/organizations/{uuid}/actions

/zstack/v1/iam2/organizations/{uuid}/actions

Operation ID

UpdateIAM2Organization

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/iam2/organizations/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"updateiam2organization":{"name":"<name>","description":"<description>","parentUuid":"<parentUuid>","type":"<type>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "3f0315c83d524c0fa0da9be22c1cd58e", "name": "org1", "state": "Enabled", "type": "Company", "parentUuid": "8b15e39fb62a43089610103be30c17b5", "attributes": [ { "uuid": "5dd14ca022554b22938d94c27de872fb", "name": "attribute-name", "value": "attribute-value", "type": "Customized" } ] } }

Change History

This API has no change history records yet.

View all change history