Help Center/ Identity and Access Management_Identity and Access Management (New Edition)/ API Reference/ API/ IAM/ Managing User Groups/ Adding an IAM User to a Group
Updated on 2025-11-06 GMT+08:00
View PDF
Share

Adding an IAM User to a Group

Function

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

Write

group *

-

-

-

URI

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

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

user_id

Yes

String

IAM user ID.

Response Parameters

Status code: 200

Successful

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 4 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 5 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 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Request ID.

Example Requests

Adding IAM user xxx to a specified group

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

{
  "user_id" : "xxx"
}

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