Amazon Cognito · Schema
ListIdentitiesInput
Input to the ListIdentities action.
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity
Properties
| Name | Type | Description |
|---|---|---|
| IdentityPoolId | object | |
| MaxResults | object | |
| NextToken | object | |
| HideDisabled | 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/identity-pools-list-identities-input-schema.json",
"title": "ListIdentitiesInput",
"description": "Input to the ListIdentities action.",
"type": "object",
"properties": {
"IdentityPoolId": {
"allOf": [
{
"$ref": "#/components/schemas/IdentityPoolId"
},
{
"description": "An identity pool ID in the format REGION:GUID."
}
]
},
"MaxResults": {
"allOf": [
{
"$ref": "#/components/schemas/QueryLimit"
},
{
"description": "The maximum number of identities to return."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/PaginationKey"
},
{
"description": "A pagination token."
}
]
},
"HideDisabled": {
"allOf": [
{
"$ref": "#/components/schemas/HideDisabled"
},
{
"description": "An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response."
}
]
}
},
"required": [
"IdentityPoolId",
"MaxResults"
]
}