Struct rusoto_cognito_idp::RespondToAuthChallengeRequest

pub struct RespondToAuthChallengeRequest {
    pub analytics_metadata: Option<AnalyticsMetadataType>,
    pub challenge_name: String,
    pub challenge_responses: Option<HashMap<String, String>>,
    pub client_id: String,
    pub client_metadata: Option<HashMap<String, String>>,
    pub session: Option<String>,
    pub user_context_data: Option<UserContextDataType>,
}

The request to respond to an authentication challenge.

Fields

analytics_metadata: Option<AnalyticsMetadataType>

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

challenge_name: String

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

challenge_responses: Option<HashMap<String, String>>

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

SECRETHASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARETOKENMFA).

• SMSMFA: SMSMFACODE, USERNAME.

• PASSWORDVERIFIER: PASSWORDCLAIMSIGNATURE, PASSWORDCLAIMSECRETBLOCK, TIMESTAMP, USERNAME.

• NEWPASSWORDREQUIRED: NEWPASSWORD, any other required attributes, USERNAME.

• SOFTWARETOKENMFA: USERNAME and SOFTWARETOKENMFACODE are required attributes.

• DEVICESRPAUTH requires USERNAME, DEVICEKEY, SRPA (and SECRETHASH).

• DEVICEPASSWORDVERIFIER requires everything that PASSWORDVERIFIER requires plus DEVICEKEY.

• MFASETUP requires USERNAME, plus you need to use the session value returned by VerifySoftwareToken in the Session parameter.

client_id: String

The app client ID.

client_metadata: 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 AWS 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 AWS 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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

session: Option<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.

user_context_data: Option<UserContextDataType>

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.

Trait Implementations

impl Clone for RespondToAuthChallengeRequest

fn clone(&self) -> RespondToAuthChallengeRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RespondToAuthChallengeRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RespondToAuthChallengeRequest

fn default() -> RespondToAuthChallengeRequest

Returns the “default value” for a type.

impl PartialEq<RespondToAuthChallengeRequest> for RespondToAuthChallengeRequest

fn eq(&self, other: &RespondToAuthChallengeRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RespondToAuthChallengeRequest) -> bool

This method tests for !=.

impl Serialize for RespondToAuthChallengeRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RespondToAuthChallengeRequest