Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cognito-idp ]

respond-to-auth-challenge

Description

Responds to the authentication challenge.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  respond-to-auth-challenge
--client-id <value>
--challenge-name <value>
[--session <value>]
[--challenge-responses <value>]
[--analytics-metadata <value>]
[--user-context-data <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--client-id (string)

The app client ID.

--challenge-name (string)

The challenge name. For more information, see .

ADMIN_NO_SRP_AUTH is not a valid value.

Possible values:

  • SMS_MFA
  • SOFTWARE_TOKEN_MFA
  • SELECT_MFA_TYPE
  • MFA_SETUP
  • PASSWORD_VERIFIER
  • CUSTOM_CHALLENGE
  • DEVICE_SRP_AUTH
  • DEVICE_PASSWORD_VERIFIER
  • ADMIN_NO_SRP_AUTH
  • NEW_PASSWORD_REQUIRED

--session (string)

The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

--challenge-responses (map)

The challenge responses. These are inputs corresponding to the value of ChallengeName , for example:

  • SMS_MFA : SMS_MFA_CODE , USERNAME , SECRET_HASH (if app client is configured with client secret).
  • PASSWORD_VERIFIER : PASSWORD_CLAIM_SIGNATURE , PASSWORD_CLAIM_SECRET_BLOCK , TIMESTAMP , USERNAME , SECRET_HASH (if app client is configured with client secret).
  • NEW_PASSWORD_REQUIRED : NEW_PASSWORD , any other required attributes, USERNAME , SECRET_HASH (if app client is configured with client secret).

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--analytics-metadata (structure)

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

Shorthand Syntax:

AnalyticsEndpointId=string

JSON Syntax:

{
  "AnalyticsEndpointId": "string"
}

--user-context-data (structure)

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Shorthand Syntax:

EncodedData=string

JSON Syntax:

{
  "EncodedData": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To respond to an authorization challenge

This example responds to an authorization challenge initiated with initiate-auth. It is a response to the NEW_PASSWORD_REQUIRED challenge. It sets a password for user jane@example.com.

Command:

aws cognito-idp respond-to-auth-challenge --client-id 3n4b5urk1ft4fl3mg5e62d9ado --challenge-name NEW_PASSWORD_REQUIRED --challenge-responses USERNAME=jane@example.com,NEW_PASSWORD="password" --session "SESSION_TOKEN"

Output:

{
  "ChallengeParameters": {},
  "AuthenticationResult": {
      "AccessToken": "ACCESS_TOKEN",
      "ExpiresIn": 3600,
      "TokenType": "Bearer",
      "RefreshToken": "REFRESH_TOKEN",
      "IdToken": "ID_TOKEN",
      "NewDeviceMetadata": {
          "DeviceKey": "us-west-2_fec070d2-fa88-424a-8ec8-b26d7198eb23",
          "DeviceGroupKey": "-wt2ha1Zd"
      }
  }
}

Output

ChallengeName -> (string)

The challenge name. For more information, see .

Session -> (string)

The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

ChallengeParameters -> (map)

The challenge parameters. For more information, see .

key -> (string)

value -> (string)

AuthenticationResult -> (structure)

The result returned by the server in response to the request to respond to the authentication challenge.

AccessToken -> (string)

The access token.

ExpiresIn -> (integer)

The expiration period of the authentication result in seconds.

TokenType -> (string)

The token type.

RefreshToken -> (string)

The refresh token.

IdToken -> (string)

The ID token.

NewDeviceMetadata -> (structure)

The new device metadata from an authentication result.

DeviceKey -> (string)

The device key.

DeviceGroupKey -> (string)

The device group key.