Updated on 2026-10-16 GMT+08:00

Adding an IAM User to a Group

Function

This API is used to add an IAM user to 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:permissions:addUserToGroupV5	Write	group *	-	-	-

URI

POST /v5/groups/{group_id}/add-user

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
group_id	Yes	String	Definition User group ID. For details about how to obtain the value, see the API for querying the user group list (ListGroupsV5). Constraints N/A Range The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	Definition IAM user ID, which is globally unique. For details about how to obtain the user ID, see the API for listing IAM users or check the IAM user details page on the IAM console. Constraints The user ID must exist and be valid. Range The value contains 32 characters, including only letters and digits. Default Value N/A

Response Parameters

Status code: 200

None

Status code: 400

**Table 3** 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 4** 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 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: 409

**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

Example Requests

Adding IAM user xxx to a specified group

POST https://{endpoint}/v5/groups/{group_id}/add-user

{
  "user_id" : "0123456789abcdef0123456789abcdef"
}

Example Responses

None

Status Codes

Status Code	Description
200	Successful
400	Bad request
403	Forbidden
404	Not found
409	Request conflicts occurred.

Error Codes

See Error Codes.

Parent topic: Managing User Groups