ListGroups
Given a user pool ID, returns user pool groups and their details.
This operation doesn't return group membership. For group membership, see ListUsersInGroup and AdminListGroupsForUser. For more information about user pool groups, see Adding groups to a user pool.
Note
Amazon Cognito evaluates AWS 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.
Request Syntax
{
"Limit": number,
"NextToken": "string",
"UserPoolId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Limit
-
The maximum number of groups that you want Amazon Cognito to return in the response.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 60.
Required: No
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Pattern:
[\S]+Required: No
- UserPoolId
-
The ID of the user pool where you want to list user groups.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+Required: Yes
Response Syntax
{
"Groups": [
{
"CreationDate": number,
"Description": "string",
"GroupName": "string",
"LastModifiedDate": number,
"Precedence": number,
"RoleArn": "string",
"UserPoolId": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Groups
-
An array of groups and their details. Each entry that's returned includes description, precedence, and IAM role values.
Type: Array of GroupType objects
- NextToken
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131072.
Pattern:
[\S]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user isn't authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service can't find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
Examples
Example
The following example request lists two groups in a user pool that has a Facebook identity provider.
Sample Request
POST HTTP/1.1
Host: cognito-idp.us-west-2.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: gzip, deflate, br
X-Amz-Target: AWSCognitoIdentityProviderService.ListGroups
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
"UserPoolId": "us-west-2_EXAMPLE",
"Limit": 2
}Sample Response
HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive
{
"Groups": [
{
"CreationDate": 1681760899.633,
"Description": "My test group",
"GroupName": "testgroup",
"LastModifiedDate": 1681760899.633,
"Precedence": 1,
"UserPoolId": "us-west-2_EXAMPLE"
},
{
"CreationDate": 1642632749.051,
"Description": "Autogenerated group for users who sign in using Facebook",
"GroupName": "us-west-2_EXAMPLE_Facebook",
"LastModifiedDate": 1642632749.051,
"UserPoolId": "us-west-2_EXAMPLE"
}
],
"NextToken": "[Pagination token]"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
