Amazon Cognito · Schema

CognitoIdentityProvider

A provider representing an Amazon Cognito user pool and its client ID.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
ProviderName object
ClientId object
ServerSideTokenCheck object
View JSON Schema on GitHub

JSON Schema

identity-pools-cognito-identity-provider-schema.json Raw ↑
{
  "$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-cognito-identity-provider-schema.json",
  "title": "CognitoIdentityProvider",
  "description": "A provider representing an Amazon Cognito user pool and its client ID.",
  "type": "object",
  "properties": {
    "ProviderName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CognitoIdentityProviderName"
        },
        {
          "description": "The provider name for an Amazon Cognito user pool. For example, <code>cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789</code>."
        }
      ]
    },
    "ClientId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CognitoIdentityProviderClientId"
        },
        {
          "description": "The client ID for the Amazon Cognito user pool."
        }
      ]
    },
    "ServerSideTokenCheck": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CognitoIdentityProviderTokenCheck"
        },
        {
          "description": "<p>TRUE if server-side token validation is enabled for the identity provider\u2019s token.</p> <p>Once you set <code>ServerSideTokenCheck</code> to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.</p> <p>If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.</p>"
        }
      ]
    }
  }
}