Amazon Cognito · Schema

AdminRespondToAuthChallengeResponse

Responds to the authentication challenge, as an administrator.

AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

Properties

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

JSON Schema

cognito-idp-admin-respond-to-auth-challenge-response-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "ChallengeName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChallengeNameType"
        },
        {
          "description": "The name of the challenge. For more information, see <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html\">AdminInitiateAuth</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_AdminInitiateAuth.html\">AdminInitiateAuth</a>."
        }
      ]
    },
    "AuthenticationResult": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AuthenticationResultType"
        },
        {
          "description": "The result returned by the server in response to the authentication request."
        }
      ]
    }
  },
  "description": "Responds to the authentication challenge, as an administrator.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-schema/cognito-idp-admin-respond-to-auth-challenge-response-schema.json",
  "title": "AdminRespondToAuthChallengeResponse"
}