Struct rusoto_cognito_idp::InitiateAuthResponse

pub struct InitiateAuthResponse {
    pub authentication_result: Option<AuthenticationResultType>,
    pub challenge_name: Option<String>,
    pub challenge_parameters: Option<HashMap<String, String>>,
    pub session: Option<String>,
}

Initiates the authentication response.

Fields

authentication_result: Option<AuthenticationResultType>

The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.

challenge_name: Option<String>

The name of the challenge which you are responding to with this call. This is returned to you in the AdminInitiateAuth response if you need to pass another challenge.

Valid values include the following. Note that all of these challenges require USERNAME and SECRETHASH (if applicable) in the parameters.

• SMSMFA: Next challenge is to supply an SMSMFACODE, delivered via SMS.

• PASSWORDVERIFIER: Next challenge is to supply PASSWORDCLAIMSIGNATURE, PASSWORDCLAIMSECRETBLOCK, and TIMESTAMP after the client-side SRP calculations.

• CUSTOMCHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.

• DEVICESRPAUTH: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.

• DEVICEPASSWORDVERIFIER: Similar to PASSWORDVERIFIER, but for devices only.

• NEWPASSWORDREQUIRED: For users which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes.

challenge_parameters: Option<HashMap<String, String>>

The challenge parameters. These are returned to you in the InitiateAuth response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge).

All challenges require USERNAME and SECRET_HASH (if applicable).

session: Option<String>

The session which should be passed both ways in challenge-response calls to the service. If the or 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.

Trait Implementations

impl PartialEq<InitiateAuthResponse> for InitiateAuthResponse

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

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

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

This method tests for !=.

impl Default for InitiateAuthResponse

fn default() -> InitiateAuthResponse

Returns the "default value" for a type.

impl Clone for InitiateAuthResponse

fn clone(&self) -> InitiateAuthResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InitiateAuthResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InitiateAuthResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.