[ aws . cognito-idp ]
Responds to an authentication challenge, as an administrator.
Note
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint . Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In * sandbox mode * , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide .
Calling this action requires developer credentials.
See also: AWS API Documentation
admin-respond-to-auth-challenge
--user-pool-id <value>
--client-id <value>
--challenge-name <value>
[--challenge-responses <value>]
[--session <value>]
[--analytics-metadata <value>]
[--context-data <value>]
[--client-metadata <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--user-pool-id
(string)
The ID of the Amazon Cognito user pool.
--client-id
(string)
The app client ID.
--challenge-name
(string)
The challenge name. For more information, see AdminInitiateAuth .
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
--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).Note
PASSWORD_VERIFIER
requiresDEVICE_KEY
when signing in with a remembered device.
ADMIN_NO_SRP_AUTH
:PASSWORD
,USERNAME
,SECRET_HASH
(if app client is configured with client secret).
NEW_PASSWORD_REQUIRED
:NEW_PASSWORD
,USERNAME
,SECRET_HASH
(if app client is configured with client secret). To set any required attributes that Amazon Cognito returned asrequiredAttributes
in theAdminInitiateAuth
response, add a ``userAttributes.*attributename* `` parameter. This parameter can also set values for writable attributes that aren’t required by your user pool.Note
In a
NEW_PASSWORD_REQUIRED
challenge response, you can’t modify a required attribute that already has a value. InAdminRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in therequiredAttributes
parameter, then use theAdminUpdateUserAttributes
API operation to modify the value of any additional attributes.
MFA_SETUP
requiresUSERNAME
, plus you must use the session value returned byVerifySoftwareToken
in theSession
parameter.The value of the
USERNAME
attribute must be the user’s actual username, not an alias (such as an email address or phone number). To make this simpler, theAdminInitiateAuth
response includes the actual username value in theUSERNAMEUSER_ID_FOR_SRP
attribute. This happens even if you specified an alias in your call toAdminInitiateAuth
.key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=stringJSON Syntax:
{"string": "string" ...}
--session
(string)The session that should be passed both ways in challenge-response calls to the service. If an
InitiateAuth
orRespondToAuthChallenge
API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the nextRespondToAuthChallenge
API call.
--analytics-metadata
(structure)The analytics metadata for collecting Amazon Pinpoint metrics for
AdminRespondToAuthChallenge
calls.AnalyticsEndpointId -> (string)
The endpoint ID.
Shorthand Syntax:
AnalyticsEndpointId=stringJSON Syntax:
{ "AnalyticsEndpointId": "string" }
--context-data
(structure)Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
IpAddress -> (string)
The source IP address of your user’s device.
ServerName -> (string)
Your server endpoint where this API is invoked.
ServerPath -> (string)
Your server path where this API is invoked.
HttpHeaders -> (list)
HttpHeaders received on your server in same order.
(structure)
The HTTP header.
headerName -> (string)
The header name.
headerValue -> (string)
The header value.
EncodedData -> (string)
Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests .
Shorthand Syntax:
IpAddress=string,ServerName=string,ServerPath=string,HttpHeaders=[{headerName=string,headerValue=string},{headerName=string,headerValue=string}],EncodedData=stringJSON Syntax:
{ "IpAddress": "string", "ServerName": "string", "ServerPath": "string", "HttpHeaders": [ { "headerName": "string", "headerValue": "string" } ... ], "EncodedData": "string" }
--client-metadata
(map)A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
pre sign-up
custom message
post authentication
user migration
pre token generation
define auth challenge
create auth challenge
verify auth challenge response
When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a
clientMetadata
attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process theclientMetadata
value to enhance your workflow for your specific needs.For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide .
Note
When you use the ClientMetadata parameter, remember that Amazon Cognito won’t do the following:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn’t include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don’t use Amazon Cognito to provide sensitive information.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=stringJSON Syntax:
{"string": "string" ...}
--cli-input-json
|--cli-input-yaml
(string) Reads arguments from the JSON string provided. The JSON string follows the format provided by--generate-cli-skeleton
. If other arguments are provided on the command line, those 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. This may not be specified along with--cli-input-yaml
.
--generate-cli-skeleton
(string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the valueinput
, prints a sample input JSON that can be used as an argument for--cli-input-json
. Similarly, if providedyaml-input
it will print a sample input YAML that can be used with--cli-input-yaml
. If provided with the valueoutput
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.Global Options¶
--debug
(boolean)Turn on debug logging.
--endpoint-url
(string)Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)Disable automatic pagination.
--output
(string)The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)A JMESPath query to use in filtering the response data.
--profile
(string)Use a specific profile from your credential file.
--region
(string)The region to use. Overrides config/env settings.
--version
(string)Display the version of this tool.
--color
(string)Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb://
will always be treated as binary and use the file contents directly regardless of thecli-binary-format
setting. When usingfile://
the file contents will need to properly formatted for the configuredcli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)Disable cli pager for output.
--cli-auto-prompt
(boolean)Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)Disable automatically prompt for CLI input parameters.
Output¶
ChallengeName -> (string)
The name of the challenge. For more information, see AdminInitiateAuth .
Session -> (string)
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
RespondToAuthChallenge
API call.ChallengeParameters -> (map)
The challenge parameters. For more information, see AdminInitiateAuth .
key -> (string)
value -> (string)
AuthenticationResult -> (structure)
The result returned by the server in response to the authentication request.
AccessToken -> (string)
A valid access token that Amazon Cognito issued to the user who you want to authenticate.
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.