Help Center/ IAM Identity Center/ API Reference/ API/ Group Membership Management/ Adding a User to a Group
Updated on 2024-04-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Adding a User to a Group

Function

This API is used to add a user to a group in the same identity source.

URI

POST /v1/identity-stores/{identity_store_id}/group-memberships

Table 1 Path parameters

Parameter

Mandatory

Type

Description

identity_store_id

Yes

String

Globally unique ID of the identity source

Minimum length: 12

Maximum length: 12

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Maximum length: 2048
Table 3 Parameters in the request body

Parameter

Mandatory

Type

Description

group_id

Yes

String

Globally unique ID of an IAM Identity Center group in the identity source

Minimum length: 1

Maximum length: 47

member_id

Yes

Object

Group member ID
Table 4 member_id

Parameter

Mandatory

Type

Description

user_id

Yes

String

Globally unique ID of an IAM Identity Center user in the identity source

Minimum length: 1

Maximum length: 47

Response Parameters

Status code: 200

Table 5 Parameters in the response body

Parameter

Type

Description

identity_store_id

String

Globally unique ID of the identity source

Minimum length: 1

Maximum length: 36

membership_id

String

Globally unique ID of the group membership in the identity source

Minimum length: 1

Maximum length: 47

Status code: 400

Table 6 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Request ID

encoded_authorization_message

String

Authentication information

Status code: 403

Table 7 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Request ID

encoded_authorization_message

String

Authentication information

Example Request

Adding a user to a group in the same identity source

POST https://{hostname}/v1/identity-stores/{identity_store_id}/group-memberships

{
  "group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a",
  "member_id" : {
    "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9"
  }
}

Example Response

Status code: 200

Successful

{
  "identity_store_id" : "d-a00aaaa33f",
  "membership_id" : "2b0aa970-7aa4-3aaf-0aae-7a2eaaaae3a5"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.