Amazon Cognito · Schema

ListIdentitiesInput

Input to the ListIdentities action.

AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

Properties

Name Type Description
IdentityPoolId object
MaxResults object
NextToken object
HideDisabled object
View JSON Schema on GitHub

JSON Schema

cognito-identity-list-identities-input-schema.json Raw ↑
{
  "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"
  ],
  "description": "Input to the ListIdentities action.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-schema/cognito-identity-list-identities-input-schema.json",
  "title": "ListIdentitiesInput"
}