Identity Pools Identity Pool Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/identity-pools-identity-pool-structure.json",
  "name": "IdentityPool",
  "description": "An object representing an Amazon Cognito identity pool.",
  "type": "object",
  "properties": {
    "IdentityPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityPoolId"
        },
        {
          "description": "An identity pool ID in the format REGION:GUID."
        }
      ]
    },
    "IdentityPoolName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityPoolName"
        },
        {
          "description": "A string that you provide."
        }
      ]
    },
    "AllowUnauthenticatedIdentities": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityPoolUnauthenticated"
        },
        {
          "description": "TRUE if the identity pool supports unauthenticated logins."
        }
      ]
    },
    "AllowClassicFlow": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClassicFlow"
        },
        {
          "description": "Enables or disables the Basic (Classic) authentication flow. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html\">Identity Pools (Federated Identities) Authentication Flow</a> in the <i>Amazon Cognito Developer Guide</i>."
        }
      ]
    },
    "SupportedLoginProviders": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityProviders"
        },
        {
          "description": "Optional key:value pairs mapping provider names to provider app IDs."
        }
      ]
    },
    "DeveloperProviderName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeveloperProviderName"
        },
        {
          "description": "The \"domain\" by which Cognito will refer to your users."
        }
      ]
    },
    "OpenIdConnectProviderARNs": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OIDCProviderList"
        },
        {
          "description": "The ARNs of the OpenID Connect providers."
        }
      ]
    },
    "CognitoIdentityProviders": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CognitoIdentityProviderList"
        },
        {
          "description": "A list representing an Amazon Cognito user pool and its client ID."
        }
      ]
    },
    "SamlProviderARNs": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SAMLProviderList"
        },
        {
          "description": "An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool."
        }
      ]
    },
    "IdentityPoolTags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityPoolTagsType"
        },
        {
          "description": "The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria."
        }
      ]
    }
  },
  "required": [
    "IdentityPoolId",
    "IdentityPoolName",
    "AllowUnauthenticatedIdentities"
  ]
}