Listing Users in a Group

Function

This API is used to list users in a group based on the group ID.

URI

GET /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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results returned for each request Minimum value: 1 Maximum value: 100 Default value: 100
marker	No	String	Pagination marker Minimum length: 24 Maximum length: 24
group_id	Yes	String	Globally unique ID of an IAM Identity Center group in the identity source Minimum length: 1 Maximum length: 64

Request Parameters

**Table 3** 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 4** Parameters in the response body
Parameter	Type	Description
group_memberships	Array of objects	Listed group members
page_info	Object	Pagination information

**Table 5** group_memberships
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 association between a user and a group in the identity source Minimum length: 1 Maximum length: 47

**Table 6** group_memberships.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

**Table 7** page_info
Parameter	Type	Description
next_marker	String	If present, it indicates that the available output is more than the output contained in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this operation until the next_marker response returns null.
current_count	Integer	Number of records returned on this page

Example Request

Listing users in a group based on the group ID

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

Example Response

Status code: 200

{
  "group_memberships" : [ {
    "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"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}