Amazon Cognito · JSON Structure

Cognito Idp Authentication Result Type Structure

The authentication result.

Type: object Properties: 6
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

AuthenticationResultType is a JSON Structure definition published by Amazon Cognito, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

AccessToken ExpiresIn TokenType RefreshToken IdToken NewDeviceMetadata

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

JSON Structure

Raw ↑
{
  "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."
        }
      ]
    }
  },
  "description": "The authentication result.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-authentication-result-type-structure.json",
  "name": "AuthenticationResultType"
}