respond_to_auth_challenge
¶
respond_to_auth_challenge(
client_id: ClientIdType,
challenge_name: ChallengeNameType,
*,
config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
session: Optional[SessionType] = None,
challenge_responses: Optional[ChallengeResponsesType] = None,
analytics_metadata: Optional[AnalyticsMetadataType] = None,
user_context_data: Optional[UserContextDataType] = None,
client_metadata: Optional[ClientMetadataType] = None,
) -> RespondToAuthChallengeResponse
Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge. A RespondToAuthChallenge API request provides the answer to that challenge, like a code or a secure remote password (SRP). The parameters of a response to an authentication challenge vary with the type of challenge.
For more information about custom authentication challenges, see Custom authentication challenge Lambda triggers.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 Services 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.
Parameters:
-
client_id(ClientIdType) –The ID of the app client where the user is signing in.
-
challenge_name(ChallengeNameType) –The name of the challenge that you are responding to.
You can't respond to an
ADMIN_NO_SRP_AUTHchallenge with this operation.Possible challenges include the following:
All of the following challenges require
USERNAMEand, when the app client has a client secret,SECRET_HASHin the parameters. Include aDEVICE_KEYfor device authentication.-
WEB_AUTHN: Respond to the challenge with the results of a successful authentication with a WebAuthn authenticator, or passkey, asCREDENTIAL. Examples of WebAuthn authenticators include biometric devices and security keys. -
PASSWORD: Respond with the user's password asPASSWORD. -
PASSWORD_SRP: Respond with the initial SRP secret asSRP_A. -
SELECT_CHALLENGE: Respond with a challenge selection asANSWER. It must be one of the challenge types in theAvailableChallengesresponse parameter. Add the parameters of the selected challenge, for exampleUSERNAMEandSMS_OTP. -
SMS_MFA: Respond with the code that your user pool delivered in an SMS message, asSMS_MFA_CODE -
EMAIL_MFA: Respond with the code that your user pool delivered in an email message, asEMAIL_MFA_CODE -
EMAIL_OTP: Respond with the code that your user pool delivered in an email message, asEMAIL_OTP_CODE. -
SMS_OTP: Respond with the code that your user pool delivered in an SMS message, asSMS_OTP_CODE. -
PASSWORD_VERIFIER: Respond with the second stage of SRP secrets asPASSWORD_CLAIM_SIGNATURE,PASSWORD_CLAIM_SECRET_BLOCK, andTIMESTAMP. -
CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. The parameters of the challenge are determined by your Lambda function and issued in theChallengeParametersof a challenge response. -
DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP authentication. For more information, see Signing in with a device. -
DEVICE_PASSWORD_VERIFIER: Respond withPASSWORD_CLAIM_SIGNATURE,PASSWORD_CLAIM_SECRET_BLOCK, andTIMESTAMPafter client-side SRP calculations. For more information, see Signing in with a device. -
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. Respond to this challenge withNEW_PASSWORDand any required attributes that Amazon Cognito returned in therequiredAttributesparameter. You can also set values for attributes that aren't required by your user pool and that your app client can write.Amazon Cognito only returns this challenge for users who have temporary passwords. When you create passwordless users, you must provide values for all required attributes.
In a
NEW_PASSWORD_REQUIREDchallenge response, you can't modify a required attribute that already has a value. InAdminRespondToAuthChallengeorRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in therequiredAttributesparameter, then use theAdminUpdateUserAttributesorUpdateUserAttributesAPI operation to modify the value of any additional attributes. -
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parametersMFAS_CAN_SETUPvalue.To set up time-based one-time password (TOTP) MFA, use the session returned in this challenge from
InitiateAuthorAdminInitiateAuthas an input toAssociateSoftwareToken. Then, use the session returned byVerifySoftwareTokenas an input toRespondToAuthChallengeorAdminRespondToAuthChallengewith challenge nameMFA_SETUPto complete sign-in.To set up SMS or email MFA, collect a
phone_numberoremailattribute for the user. Then restart the authentication flow with anInitiateAuthorAdminInitiateAuthrequest.
-
-
session(Optional[SessionType], default:None) –The session identifier that maintains the state of authentication requests and challenge responses. If an
AdminInitiateAuthorAdminRespondToAuthChallengeAPI request results in a determination that your application must pass another challenge, Amazon Cognito returns a session with other challenge parameters. Send this session identifier, unmodified, to the nextAdminRespondToAuthChallengerequest. -
challenge_responses(Optional[ChallengeResponsesType], default:None) –The responses to the challenge that you received in the previous request. Each challenge has its own required response parameters. The following examples are partial JSON request bodies that highlight challenge-response parameters.
You must provide a SECRET_HASH parameter in all challenge responses to an app client that has a client secret. Include a
DEVICE_KEYfor device authentication.- SELECT_CHALLENGE
-
"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": { "USERNAME": "[username]", "ANSWER": "[Challenge name]"}Available challenges are
PASSWORD,PASSWORD_SRP,EMAIL_OTP,SMS_OTP, andWEB_AUTHN.Complete authentication in the
SELECT_CHALLENGEresponse forPASSWORD,PASSWORD_SRP, andWEB_AUTHN:-
"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": { "ANSWER": "WEB_AUTHN", "USERNAME": "[username]", "CREDENTIAL": "[AuthenticationResponseJSON]"} -
"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": { "ANSWER": "PASSWORD", "USERNAME": "[username]", "PASSWORD": "[password]"} -
"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": { "ANSWER": "PASSWORD_SRP", "USERNAME": "[username]", "SRP_A": "[SRP_A]"}
For
SMS_OTPandEMAIL_OTP, respond with the username and answer. Your user pool will send a code for the user to submit in the next challenge response.-
"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": { "ANSWER": "SMS_OTP", "USERNAME": "[username]"} -
"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": { "ANSWER": "EMAIL_OTP", "USERNAME": "[username]"}
-
- WEB_AUTHN
-
"ChallengeName": "WEB_AUTHN", "ChallengeResponses": { "USERNAME": "[username]", "CREDENTIAL": "[AuthenticationResponseJSON]"} - PASSWORD
-
"ChallengeName": "PASSWORD", "ChallengeResponses": { "USERNAME": "[username]", "PASSWORD": "[password]"} - PASSWORD_SRP
-
"ChallengeName": "PASSWORD_SRP", "ChallengeResponses": { "USERNAME": "[username]", "SRP_A": "[SRP_A]"} - SMS_OTP
-
"ChallengeName": "SMS_OTP", "ChallengeResponses": {"SMS_OTP_CODE": "[code]", "USERNAME": "[username]"} - EMAIL_OTP
-
"ChallengeName": "EMAIL_OTP", "ChallengeResponses": {"EMAIL_OTP_CODE": "[code]", "USERNAME": "[username]"} - SMS_MFA
-
"ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": "[code]", "USERNAME": "[username]"} - PASSWORD_VERIFIER
-
This challenge response is part of the SRP flow. Amazon Cognito requires that your application respond to this challenge within a few seconds. When the response time exceeds this period, your user pool returns a
NotAuthorizedExceptionerror."ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"} - CUSTOM_CHALLENGE
-
"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"} - NEW_PASSWORD_REQUIRED
-
"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}To set any required attributes that
InitiateAuthreturned in anrequiredAttributesparameter, add"userAttributes.[attribute_name]": "[attribute_value]". This parameter can also set values for writable attributes that aren't required by your user pool.In a
NEW_PASSWORD_REQUIREDchallenge response, you can't modify a required attribute that already has a value. InAdminRespondToAuthChallengeorRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in therequiredAttributesparameter, then use theAdminUpdateUserAttributesorUpdateUserAttributesAPI operation to modify the value of any additional attributes. - SOFTWARE_TOKEN_MFA
-
"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses": {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE": [authenticator_code]} - DEVICE_SRP_AUTH
-
"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A": "[srp_a]"} - DEVICE_PASSWORD_VERIFIER
-
"ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses": {"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"} - MFA_SETUP
-
"ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME": "[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]" - SELECT_MFA_TYPE
-
"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]"}
For more information about
SECRET_HASH, see Computing secret hash values. For information aboutDEVICE_KEY, see Working with user devices in your user pool. -
analytics_metadata(Optional[AnalyticsMetadataType], default:None) –Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
-
user_context_data(Optional[UserContextDataType], default:None) –Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection 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.
For more information, see Collecting data for threat protection in applications.
-
client_metadata(Optional[ClientMetadataType], default:None) –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 Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a
clientMetadataattribute that provides the data that you assigned to the ClientMetadata parameter in your request. In your function code, you can process theclientMetadatavalue to enhance your workflow for your specific needs.To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see Connecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
When you use the
ClientMetadataparameter, note that Amazon Cognito won't do the following:-
Store the
ClientMetadatavalue. 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, theClientMetadataparameter serves no purpose. -
Validate the
ClientMetadatavalue. -
Encrypt the
ClientMetadatavalue. Don't send sensitive information in this parameter.
-
Raises:
-
AliasExistsException–This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
-
CodeMismatchException–This exception is thrown if the provided code doesn't match what the server was expecting.
-
ExpiredCodeException–This exception is thrown if a code has expired.
-
ForbiddenException–This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.
-
InternalErrorException–This exception is thrown when Amazon Cognito encounters an internal error.
-
InvalidEmailRoleAccessPolicyException–This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
-
InvalidLambdaResponseException–This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
-
InvalidParameterException–This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
-
InvalidPasswordException–This exception is thrown when Amazon Cognito encounters an invalid password.
-
InvalidSmsRoleAccessPolicyException–This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
-
InvalidSmsRoleTrustRelationshipException–This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust
cognito-idp.amazonaws.comor the external ID provided in the role does not match what is provided in the SMS configuration for the user pool. -
InvalidUserPoolConfigurationException–This exception is thrown when the user pool configuration is not valid.
-
MFAMethodNotFoundException–This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.
-
NotAuthorizedException–This exception is thrown when a user isn't authorized.
-
OperationNotEnabledException–This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.
-
PasswordHistoryPolicyViolationException–The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.
-
PasswordResetRequiredException–This exception is thrown when a password reset is required.
-
ResourceNotFoundException–This exception is thrown when the Amazon Cognito service can't find the requested resource.
-
SoftwareTokenMFANotFoundException–This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.
-
TooManyRequestsException–This exception is thrown when the user has made too many requests for a given operation.
-
UnexpectedLambdaException–This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
-
UserLambdaValidationException–This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
-
UserNotConfirmedException–This exception is thrown when a user isn't confirmed successfully.
-
UserNotFoundException–This exception is thrown when a user isn't found.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_cognito_identity_provider/_services/cognito_identity_provider.py
8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 | |