cognitoidentityprovider_admin_list_groups_for_user: Lists the groups that a user belongs to

In paws.security.identity: 'Amazon Web Services' Security, Identity, & Compliance Services

Lists the groups that a user belongs to

Description

Lists the groups that a user belongs to. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool.

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_admin_list_groups_for_user/ for full documentation.

Usage

cognitoidentityprovider_admin_list_groups_for_user(
  Username,
  UserPoolId,
  Limit = NULL,
  NextToken = NULL
)

Arguments

Username	[required] The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
UserPoolId	[required] The ID of the user pool where you want to view a user's groups.
Limit	The maximum number of groups that you want Amazon Cognito to return in the response.
NextToken	This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

paws.security.identity documentation built on April 3, 2025, 10:59 p.m.