Modifying a Group

Function

This API is used to modify a group.

Authorization Information

Each account root user 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	Definition: User group ID. Constraints: The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A

Request Parameters

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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
group	group object	Definition: User group. Range: N/A

**Table 4** group
Parameter	Type	Description
group_id	String	Definition: User group ID. Range: N/A
group_name	String	Definition: User group name. Range: N/A
created_at	String	Definition: Time when the user group was created. Range: N/A
urn	String	Definition : Uniform Resource Name (URN). For details, see Reference. Range: N/A.
description	String	Definition: User group description. Range: N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A
encoded_authorization_message	String	Definition : Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link. Range: N/A.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

Status code: 409

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

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