Amazon Cognito · Schema

RespondToAuthChallengeResponse

The response to respond to the authentication challenge.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
ChallengeName object
Session object
ChallengeParameters object
AuthenticationResult object
View JSON Schema on GitHub

JSON Schema

user-pools-respond-to-auth-challenge-response-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-respond-to-auth-challenge-response-schema.json",
  "title": "RespondToAuthChallengeResponse",
  "description": "The response to respond to the authentication challenge.",
  "type": "object",
  "properties": {
    "ChallengeName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChallengeNameType"
        },
        {
          "description": "The challenge name. For more information, see <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html\">InitiateAuth</a>."
        }
      ]
    },
    "Session": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SessionType"
        },
        {
          "description": "The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call."
        }
      ]
    },
    "ChallengeParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChallengeParametersType"
        },
        {
          "description": "The challenge parameters. For more information, see <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html\">InitiateAuth</a>."
        }
      ]
    },
    "AuthenticationResult": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AuthenticationResultType"
        },
        {
          "description": "The result returned by the server in response to the request to respond to the authentication challenge."
        }
      ]
    }
  }
}