Amazon Cognito · Schema
ListUsersResponse
The response from the request to list users.
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity
Properties
| Name | Type | Description |
|---|---|---|
| Users | object | |
| PaginationToken | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-list-users-response-schema.json",
"title": "ListUsersResponse",
"description": "The response from the request to list users.",
"type": "object",
"properties": {
"Users": {
"allOf": [
{
"$ref": "#/components/schemas/UsersListType"
},
{
"description": "<p>A list of the user pool users, and their attributes, that match your query.</p> <note> <p>Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html\">AdminLinkProviderForUser</a> API operation, the output of <code>ListUsers</code> displays both the IdP user and the native user that you linked. You can identify IdP users in the <code>Users</code> object of this API response by the IdP prefix that Amazon Cognito appends to <code>Username</code>.</p> </note>"
}
]
},
"PaginationToken": {
"allOf": [
{
"$ref": "#/components/schemas/SearchPaginationTokenType"
},
{
"description": "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."
}
]
}
}
}