Skip to content

List Group Memberships

identitystore_list_group_memberships R Documentation

For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form

Description

For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Usage

identitystore_list_group_memberships(IdentityStoreId, GroupId,
  MaxResults, NextToken)

Arguments

IdentityStoreId

[required] The globally unique identifier for the identity store.
GroupId

[required] The identifier for a group in the identity store.
MaxResults

The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
NextToken

The pagination token used for the list_users, list_groups and list_group_memberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Value

A list with the following syntax:

list(
  GroupMemberships = list(
    list(
      IdentityStoreId = "string",
      MembershipId = "string",
      GroupId = "string",
      MemberId = list(
        UserId = "string"
      ),
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      CreatedBy = "string",
      UpdatedBy = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_group_memberships(
  IdentityStoreId = "string",
  GroupId = "string",
  MaxResults = 123,
  NextToken = "string"
)