Amazon Cognito · Schema

AuthenticationResultType

The authentication result.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
AccessToken object
ExpiresIn object
TokenType object
RefreshToken object
IdToken object
NewDeviceMetadata object
View JSON Schema on GitHub

JSON Schema

user-pools-authentication-result-type-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/user-pools-authentication-result-type-schema.json",
  "title": "AuthenticationResultType",
  "description": "The authentication result.",
  "type": "object",
  "properties": {
    "AccessToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TokenModelType"
        },
        {
          "description": "A valid access token that Amazon Cognito issued to the user who you want to authenticate."
        }
      ]
    },
    "ExpiresIn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IntegerType"
        },
        {
          "description": "The expiration period of the authentication result in seconds."
        }
      ]
    },
    "TokenType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "The token type."
        }
      ]
    },
    "RefreshToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TokenModelType"
        },
        {
          "description": "The refresh token."
        }
      ]
    },
    "IdToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TokenModelType"
        },
        {
          "description": "The ID token."
        }
      ]
    },
    "NewDeviceMetadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NewDeviceMetadataType"
        },
        {
          "description": "The new device metadata from an authentication result."
        }
      ]
    }
  }
}