CognitoIdentityProvider / Client / admin_list_groups_for_user
admin_list_groups_for_user#
- CognitoIdentityProvider.Client.admin_list_groups_for_user(**kwargs)#
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.
Note
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
See also: AWS API Documentation
Request Syntax
response = client.admin_list_groups_for_user( Username='string', UserPoolId='string', Limit=123, NextToken='string' )
- Parameters:
Username (string) –
[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 thesub
of a local user or the username of a user from a third-party IdP.UserPoolId (string) –
[REQUIRED]
The ID of the user pool where you want to view a user’s groups.
Limit (integer) – The maximum number of groups that you want Amazon Cognito to return in the response.
NextToken (string) – 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.
- Return type:
dict
- Returns:
Response Syntax
{ 'Groups': [ { 'GroupName': 'string', 'UserPoolId': 'string', 'Description': 'string', 'RoleArn': 'string', 'Precedence': 123, 'LastModifiedDate': datetime(2015, 1, 1), 'CreationDate': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
Groups (list) –
An array of groups and information about them.
(dict) –
A user pool group. Contains details about the group and the way that it contributes to IAM role decisions with identity pools. Identity pools can make decisions about the IAM role to assign based on groups: users get credentials for the role associated with their highest-priority group.
This data type is a response parameter of AdminListGroupsForUser, CreateGroup, GetGroup, ListGroups, and UpdateGroup.
GroupName (string) –
The name of the group.
UserPoolId (string) –
The ID of the user pool that contains the group.
Description (string) –
A friendly description of the group.
RoleArn (string) –
The ARN of the IAM role associated with the group. If a group has the highest priority of a user’s groups, users who authenticate with an identity pool get credentials for the
RoleArn
that’s associated with the group.Precedence (integer) –
A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower
Precedence
values take precedence over groups with higher ornullPrecedence
values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user’s tokens for thecognito:roles
andcognito:preferred_role
claims.Two groups can have the same
Precedence
value. If this happens, neither group takes precedence over the other. If two groups with the samePrecedence
have the same role ARN, that role is used in thecognito:preferred_role
claim in tokens for users in each group. If the two groups have different role ARNs, thecognito:preferred_role
claim isn’t set in users’ tokens.The default
Precedence
value isnull
.LastModifiedDate (datetime) –
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.CreationDate (datetime) –
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.
NextToken (string) –
The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.
Exceptions
CognitoIdentityProvider.Client.exceptions.InvalidParameterException
CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
CognitoIdentityProvider.Client.exceptions.UserNotFoundException
CognitoIdentityProvider.Client.exceptions.InternalErrorException