Modify Group Name and Description via UpdateGroup API - CloudSSO

Operation description

You can modify GroupName and Description for a group.

Note

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

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cloudsso:UpdateGroup

update

*Group

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/group/{#GroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****
GroupId	string	Yes	The ID of the group.	g-00jqzghi2n3o5hkh****
NewGroupName	string	No	The new name of the group.	NewTestGroup
NewDescription	string	No	The new description of the group.	This is a group.

Response elements

Element	Type	Description	Example
	object	The response parameters.
Group	object	The information about the group.
GroupName	string	The name of the group.	NewTestGroup
Description	string	The description of the group.	This is a group.
CreateTime	string	The time when the group was created.	2021-11-01T02:38:27Z
ProvisionType	string	The type of the group. Valid values: Manual: The group is manually created. Synchronized: The group is synchronized from an external identity provider (IdP).	Manual
UpdateTime	string	The time when the group was modified.	2021-11-01T06:06:11Z
GroupId	string	The ID of the group.	g-00jqzghi2n3o5hkh****
RequestId	string	The request ID.	F723DE01-6276-5DC4-9B1F-9CBE3E1748B2

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.