Struct aws_sdk_cognitoidentityprovider::operation::respond_to_auth_challenge::builders::RespondToAuthChallengeFluentBuilder
source · pub struct RespondToAuthChallengeFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to RespondToAuthChallenge
.
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 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.
Implementations§
source§impl RespondToAuthChallengeFluentBuilder
impl RespondToAuthChallengeFluentBuilder
sourcepub fn as_input(&self) -> &RespondToAuthChallengeInputBuilder
pub fn as_input(&self) -> &RespondToAuthChallengeInputBuilder
Access the RespondToAuthChallenge as a reference.
sourcepub async fn send(
self
) -> Result<RespondToAuthChallengeOutput, SdkError<RespondToAuthChallengeError, HttpResponse>>
pub async fn send( self ) -> Result<RespondToAuthChallengeOutput, SdkError<RespondToAuthChallengeError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<RespondToAuthChallengeOutput, RespondToAuthChallengeError, Self>
pub fn customize( self ) -> CustomizableOperation<RespondToAuthChallengeOutput, RespondToAuthChallengeError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn set_client_id(self, input: Option<String>) -> Self
pub fn set_client_id(self, input: Option<String>) -> Self
The app client ID.
sourcepub fn get_client_id(&self) -> &Option<String>
pub fn get_client_id(&self) -> &Option<String>
The app client ID.
sourcepub fn challenge_name(self, input: ChallengeNameType) -> Self
pub fn challenge_name(self, input: ChallengeNameType) -> Self
The challenge name. For more information, see InitiateAuth.
ADMIN_NO_SRP_AUTH
isn't a valid value.
sourcepub fn set_challenge_name(self, input: Option<ChallengeNameType>) -> Self
pub fn set_challenge_name(self, input: Option<ChallengeNameType>) -> Self
The challenge name. For more information, see InitiateAuth.
ADMIN_NO_SRP_AUTH
isn't a valid value.
sourcepub fn get_challenge_name(&self) -> &Option<ChallengeNameType>
pub fn get_challenge_name(&self) -> &Option<ChallengeNameType>
The challenge name. For more information, see InitiateAuth.
ADMIN_NO_SRP_AUTH
isn't a valid value.
sourcepub fn session(self, input: impl Into<String>) -> Self
pub fn session(self, input: impl Into<String>) -> Self
The session that should be passed both ways in challenge-response calls to the service. If InitiateAuth
or RespondToAuthChallenge
API call determines that 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.
sourcepub fn set_session(self, input: Option<String>) -> Self
pub fn set_session(self, input: Option<String>) -> Self
The session that should be passed both ways in challenge-response calls to the service. If InitiateAuth
or RespondToAuthChallenge
API call determines that 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.
sourcepub fn get_session(&self) -> &Option<String>
pub fn get_session(&self) -> &Option<String>
The session that should be passed both ways in challenge-response calls to the service. If InitiateAuth
or RespondToAuthChallenge
API call determines that 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.
sourcepub fn challenge_responses(
self,
k: impl Into<String>,
v: impl Into<String>
) -> Self
pub fn challenge_responses( self, k: impl Into<String>, v: impl Into<String> ) -> Self
Adds a key-value pair to ChallengeResponses
.
To override the contents of this collection use set_challenge_responses
.
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.
- SMS_MFA
-
"ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": "[SMS_code]", "USERNAME": "[username]"}
- PASSWORD_VERIFIER
-
"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}
Add
"DEVICE_KEY"
when you sign in with a remembered device. - CUSTOM_CHALLENGE
-
"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}
Add
"DEVICE_KEY"
when you sign in with a remembered device. - NEW_PASSWORD_REQUIRED
-
"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}
To set any required attributes that
InitiateAuth
returned in anrequiredAttributes
parameter, 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_REQUIRED
challenge response, you can't modify a required attribute that already has a value. InRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in therequiredAttributes
parameter, then use theUpdateUserAttributes
API 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 or SOFTWARE_TOKEN_MFA]"}
For more information about SECRET_HASH
, see Computing secret hash values. For information about DEVICE_KEY
, see Working with user devices in your user pool.
sourcepub fn set_challenge_responses(
self,
input: Option<HashMap<String, String>>
) -> Self
pub fn set_challenge_responses( self, input: Option<HashMap<String, String>> ) -> Self
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.
- SMS_MFA
-
"ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": "[SMS_code]", "USERNAME": "[username]"}
- PASSWORD_VERIFIER
-
"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}
Add
"DEVICE_KEY"
when you sign in with a remembered device. - CUSTOM_CHALLENGE
-
"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}
Add
"DEVICE_KEY"
when you sign in with a remembered device. - NEW_PASSWORD_REQUIRED
-
"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}
To set any required attributes that
InitiateAuth
returned in anrequiredAttributes
parameter, 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_REQUIRED
challenge response, you can't modify a required attribute that already has a value. InRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in therequiredAttributes
parameter, then use theUpdateUserAttributes
API 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 or SOFTWARE_TOKEN_MFA]"}
For more information about SECRET_HASH
, see Computing secret hash values. For information about DEVICE_KEY
, see Working with user devices in your user pool.
sourcepub fn get_challenge_responses(&self) -> &Option<HashMap<String, String>>
pub fn get_challenge_responses(&self) -> &Option<HashMap<String, String>>
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.
- SMS_MFA
-
"ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": "[SMS_code]", "USERNAME": "[username]"}
- PASSWORD_VERIFIER
-
"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}
Add
"DEVICE_KEY"
when you sign in with a remembered device. - CUSTOM_CHALLENGE
-
"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}
Add
"DEVICE_KEY"
when you sign in with a remembered device. - NEW_PASSWORD_REQUIRED
-
"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}
To set any required attributes that
InitiateAuth
returned in anrequiredAttributes
parameter, 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_REQUIRED
challenge response, you can't modify a required attribute that already has a value. InRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in therequiredAttributes
parameter, then use theUpdateUserAttributes
API 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 or SOFTWARE_TOKEN_MFA]"}
For more information about SECRET_HASH
, see Computing secret hash values. For information about DEVICE_KEY
, see Working with user devices in your user pool.
sourcepub fn analytics_metadata(self, input: AnalyticsMetadataType) -> Self
pub fn analytics_metadata(self, input: AnalyticsMetadataType) -> Self
The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge
calls.
sourcepub fn set_analytics_metadata(
self,
input: Option<AnalyticsMetadataType>
) -> Self
pub fn set_analytics_metadata( self, input: Option<AnalyticsMetadataType> ) -> Self
The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge
calls.
sourcepub fn get_analytics_metadata(&self) -> &Option<AnalyticsMetadataType>
pub fn get_analytics_metadata(&self) -> &Option<AnalyticsMetadataType>
The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge
calls.
sourcepub fn user_context_data(self, input: UserContextDataType) -> Self
pub fn user_context_data(self, input: UserContextDataType) -> Self
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.
sourcepub fn set_user_context_data(self, input: Option<UserContextDataType>) -> Self
pub fn set_user_context_data(self, input: Option<UserContextDataType>) -> Self
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.
sourcepub fn get_user_context_data(&self) -> &Option<UserContextDataType>
pub fn get_user_context_data(&self) -> &Option<UserContextDataType>
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.
sourcepub fn client_metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn client_metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to ClientMetadata
.
To override the contents of this collection use set_client_metadata
.
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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. 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, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata
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.
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.
sourcepub fn set_client_metadata(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_client_metadata(self, input: Option<HashMap<String, String>>) -> Self
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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. 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, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata
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.
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.
sourcepub fn get_client_metadata(&self) -> &Option<HashMap<String, String>>
pub fn get_client_metadata(&self) -> &Option<HashMap<String, String>>
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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. 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, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata
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.
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.
Trait Implementations§
source§impl Clone for RespondToAuthChallengeFluentBuilder
impl Clone for RespondToAuthChallengeFluentBuilder
source§fn clone(&self) -> RespondToAuthChallengeFluentBuilder
fn clone(&self) -> RespondToAuthChallengeFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for RespondToAuthChallengeFluentBuilder
impl !RefUnwindSafe for RespondToAuthChallengeFluentBuilder
impl Send for RespondToAuthChallengeFluentBuilder
impl Sync for RespondToAuthChallengeFluentBuilder
impl Unpin for RespondToAuthChallengeFluentBuilder
impl !UnwindSafe for RespondToAuthChallengeFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more