ListUsers
Lists the users in the Amazon Cognito user pool.
Request Syntax
{
"AttributesToGet": [ "string
" ],
"Filter": "string
",
"Limit": number
,
"PaginationToken": "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.
- AttributesToGet
-
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Required: No
- Filter
-
A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "
family_name
= \"Reddy\"".-
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
-
Filter-Type: For an exact match, use =, for example, "
given_name
= \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name
^= \"Jon\"". -
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty,
ListUsers
returns all users in the user pool.You can only search for the following standard attributes:
-
username
(case-sensitive) -
email
-
phone_number
-
name
-
given_name
-
family_name
-
preferred_username
-
cognito:user_status
(called Status in the Console) (case-insensitive) -
status (called Enabled in the Console) (case-sensitive)
-
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
Type: String
Length Constraints: Maximum length of 256.
Required: No
-
- Limit
-
Maximum number of users to be returned.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 60.
Required: No
- PaginationToken
-
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
[\S]+
Required: No
- UserPoolId
-
The user pool ID for the user pool on which the search should be performed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+
Required: Yes
Response Syntax
{
"PaginationToken": "string",
"Users": [
{
"Attributes": [
{
"Name": "string",
"Value": "string"
}
],
"Enabled": boolean,
"MFAOptions": [
{
"AttributeName": "string",
"DeliveryMedium": "string"
}
],
"UserCreateDate": number,
"UserLastModifiedDate": number,
"Username": "string",
"UserStatus": "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.
- PaginationToken
-
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
[\S]+
- Users
-
The users returned in the request to list users.
Type: Array of UserType objects
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 is not authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service cannot 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: