admin_respond_to_auth_challenge
¶
admin_respond_to_auth_challenge(
user_pool_id: UserPoolIdType,
client_id: ClientIdType,
challenge_name: ChallengeNameType,
*,
config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
challenge_responses: Optional[ChallengeResponsesType] = None,
session: Optional[SessionType] = None,
analytics_metadata: Optional[AnalyticsMetadataType] = None,
context_data: Optional[ContextDataType] = None,
client_metadata: Optional[ClientMetadataType] = None,
) -> AdminRespondToAuthChallengeResponse
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. An AdminRespondToAuthChallenge 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.
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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Parameters:
-
user_pool_id(UserPoolIdType) –The ID of the user pool where you want to respond to an authentication challenge.
-
client_id(ClientIdType) –The ID of the app client where you initiated sign-in.
-
challenge_name(ChallengeNameType) –The name of the challenge that you are responding to.
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.
-
-
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. -
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. -
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.
-
context_data(Optional[ContextDataType], 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.
-
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
2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 | |