Modifying a Group

Function

This API is used to modify a group.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iam:groups:updateGroupV5	Write	group *	-	-	-

URI

PUT /v5/groups/{group_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
group_id	Yes	String	Group ID. The value contains 1 to 64 characters, including only letters, digits, and hyphens (-).

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
new_group_name	No	String	User group name. The value can contain 1 to 128 characters, including letters, digits, spaces, underscores (_), hyphens (-), and braces ({ and }).
new_group_description	No	String	User group description. The value can contain 0 to 255 characters and cannot contain the following special characters: @, #, %, &, <, >, \, $, ^, and *.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
group	Group object	Group.

**Table 4** Group
Parameter	Type	Description
group_id	String	Group ID.
group_name	String	User group name. The value can contain 1 to 128 characters, including letters, digits, spaces, underscores (_), hyphens (-), and braces ({ and }).
created_at	String	Time when a group was created.
urn	String	Uniform resource name.
description	String	User group description. The value can contain 0 to 255 characters and cannot contain the following special characters: @, #, %, &, <, >, \, $, ^, and *.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.
encoded_authorization_message	String	Encrypted authentication failure information, which can be decrypted using the STS5 decryption API.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.

Status code: 409

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.

Example Requests

Modifying a group

PUT https://{endpoint}/v5/groups/{group_id}

{
  "new_group_name" : "name",
  "new_group_description" : "description"
}

Example Responses

Status code: 200

Successful

{
  "group" : {
    "group_id" : "string",
    "group_name" : "name",
    "created_at" : "2023-09-11T10:13:25.414Z",
    "urn" : "iam::accountid:group:name",
    "description" : "description"
  }
}