Modifies information about a group.

Usage notes

You can modify GroupName and Description for a group.

Note If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a group that is synchronized by using SCIM.

This topic provides an example on how to change the name of the group g-00jqzghi2n3o5hkh**** to NewTestGroup.

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateGroup

The operation that you want to perform. Set the value to UpdateGroup.

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

GroupId String Yes g-00jqzghi2n3o5hkh****

The ID of the group.

NewGroupName String No NewTestGroup

The new name of the group.

NewDescription String No This is a group.

The new description of the group.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Group Object

The information about the group.

GroupName String NewTestGroup

The name of the group.

Description String This is a group.

The description of the group.

CreateTime String 2021-11-01T02:38:27Z

The time when the group was created.

ProvisionType String Manual

The type of the group. Valid values:

  • Manual: The group is manually created.
  • Synchronized: The user is synchronized from an external identity provider (IdP).
UpdateTime String 2021-11-01T06:06:11Z

The time when the information about the group was modified.

GroupId String g-00jqzghi2n3o5hkh****

The ID of the group.

RequestId String F723DE01-6276-5DC4-9B1F-9CBE3E1748B2

The ID of the request.

Examples

Sample requests

https://[Endpoint]/?Action=UpdateGroup
&DirectoryId=d-00fc2p61****
&GroupId=g-00jqzghi2n3o5hkh****
&NewGroupName=NewTestGroup
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateGroupResponse>
    <Group>
        <GroupName>NewTestGroup</GroupName>
        <Description>This is a group.</Description>
        <CreateTime>2021-11-01T02:38:27Z</CreateTime>
        <ProvisionType>Manual</ProvisionType>
        <UpdateTime>2021-11-01T06:06:11Z</UpdateTime>
        <GroupId>g-00jqzghi2n3o5hkh****</GroupId>
    </Group>
    <RequestId>F723DE01-6276-5DC4-9B1F-9CBE3E1748B2</RequestId>
</UpdateGroupResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Group" : {
    "GroupName" : "NewTestGroup",
    "Description" : "This is a group.",
    "CreateTime" : "2021-11-01T02:38:27Z",
    "ProvisionType" : "Manual",
    "UpdateTime" : "2021-11-01T06:06:11Z",
    "GroupId" : "g-00jqzghi2n3o5hkh****"
  },
  "RequestId" : "F723DE01-6276-5DC4-9B1F-9CBE3E1748B2"
}

Error codes

For a list of error codes, visit the API Error Center.