Amazon Cognito · JSON Structure

Cognito Idp Respond To Auth Challenge Response Structure

The response to respond to the authentication challenge.

Type: object Properties: 4
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

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

Properties

ChallengeName Session ChallengeParameters AuthenticationResult

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

JSON Structure

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