Amazon Cognito · JSON Structure

Identity Pools Get Open Id Token Input Structure

Input to the GetOpenIdToken action.

Type: object Properties: 2 Required: 1
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

GetOpenIdTokenInput is a JSON Structure definition published by Amazon Cognito, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

IdentityId Logins

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/identity-pools-get-open-id-token-input-structure.json",
  "name": "GetOpenIdTokenInput",
  "description": "Input to the GetOpenIdToken action.",
  "type": "object",
  "properties": {
    "IdentityId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityId"
        },
        {
          "description": "A unique identifier in the format REGION:GUID."
        }
      ]
    },
    "Logins": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LoginsMap"
        },
        {
          "description": "A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any other OpenID Connect provider, always include the <code>id_token</code>."
        }
      ]
    }
  },
  "required": [
    "IdentityId"
  ]
}