Querying the Group Membership

Function

This API is used to query details about the group membership based on the group membership ID.

URI

GET /v1/identity-stores/{identity_store_id}/group-memberships/{membership_id}

**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
membership_id	Yes	String	Globally unique ID of the group membership in the identity source Minimum length: 1 Maximum length: 64

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

Response Parameters

Status code: 200

**Table 3** Parameters in the response body
Parameter	Type	Description
group_id	String	Globally unique ID of an IAM Identity Center group in the identity source Minimum length: 1 Maximum length: 47
identity_store_id	String	Globally unique ID of the identity source Minimum length: 1 Maximum length: 36
member_id	Object	Group member ID
membership_id	String	Globally unique ID of the group membership in the identity source Minimum length: 1 Maximum length: 47

**Table 4** member_id
Parameter	Type	Description
user_id	String	Globally unique ID of an IAM Identity Center user in the identity source Minimum length: 1 Maximum length: 47

Status code: 400

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

Example Request

Querying details about the group membership based on the group membership ID

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

Example Response

Status code: 200

Successful

{
  "group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a",
  "identity_store_id" : "d-a00aaaa33f",
  "member_id" : {
    "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9"
  },
  "membership_id" : "2b0aa970-7aa4-3aaf-0aae-7a2eaaaae3a5"
}