[−][src]Struct rusoto_cognito_idp::InitiateAuthResponse
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 anSMSMFACODE
, delivered via SMS. -
PASSWORDVERIFIER
: Next challenge is to supplyPASSWORDCLAIMSIGNATURE
,PASSWORDCLAIMSECRETBLOCK
, andTIMESTAMP
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 toPASSWORDVERIFIER
, but for devices only. -
NEWPASSWORDREQUIRED
: For users which are required to change their passwords after successful first login. This challenge should be passed withNEW_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 Clone for InitiateAuthResponse
[src]
pub fn clone(&self) -> InitiateAuthResponse
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for InitiateAuthResponse
[src]
impl Default for InitiateAuthResponse
[src]
pub fn default() -> InitiateAuthResponse
[src]
impl<'de> Deserialize<'de> for InitiateAuthResponse
[src]
pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<InitiateAuthResponse> for InitiateAuthResponse
[src]
pub fn eq(&self, other: &InitiateAuthResponse) -> bool
[src]
pub fn ne(&self, other: &InitiateAuthResponse) -> bool
[src]
impl StructuralPartialEq for InitiateAuthResponse
[src]
Auto Trait Implementations
impl RefUnwindSafe for InitiateAuthResponse
[src]
impl Send for InitiateAuthResponse
[src]
impl Sync for InitiateAuthResponse
[src]
impl Unpin for InitiateAuthResponse
[src]
impl UnwindSafe for InitiateAuthResponse
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,