pub struct AdminInitiateAuthResponse {
pub authentication_result: Option<AuthenticationResultType>,
pub challenge_name: Option<String>,
pub challenge_parameters: Option<HashMap<String, String>>,
pub session: Option<String>,
}
Expand description
Initiates the authentication response, as an administrator.
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.
-
MFASETUP
: If MFA is required, users who do not have at least one of the MFA methods set up are presented with anMFASETUP
challenge. The user must set up at least one MFA type to continue to authenticate. -
SELECTMFATYPE
: Selects the MFA type. Valid MFA options areSMSMFA
for text SMS MFA, andSOFTWARETOKENMFA
for TOTP software token MFA. -
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. -
ADMINNOSRPAUTH
: This is returned if you need to authenticate withUSERNAME
andPASSWORD
directly. An app client must be enabled to use this flow. -
NEWPASSWORDREQUIRED
: For users who are required to change their passwords after successful first login. This challenge should be passed withNEWPASSWORD
and any other required attributes. -
MFASETUP
: For users who are required to setup an MFA factor before they can sign-in. The MFA types enabled for the user pool will be listed in the challenge parametersMFACANSETUP
value.To setup software token MFA, use the session returned here from
InitiateAuth
as an input toAssociateSoftwareToken
, and use the session returned byVerifySoftwareToken
as an input toRespondToAuthChallenge
with challenge nameMFASETUP
to complete sign-in. To setup SMS MFA, users will need help from an administrator to add a phone number to their account and then callInitiateAuth
again to restart sign-in.
challenge_parameters: Option<HashMap<String, String>>
The challenge parameters. These are returned to you in the AdminInitiateAuth
response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (AdminRespondToAuthChallenge
).
All challenges require USERNAME
and SECRET_HASH
(if applicable).
The value of the USER_ID_FOR_SRP
attribute will be the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth
. This is because, in the AdminRespondToAuthChallenge
API ChallengeResponses
, the USERNAME
attribute cannot be an alias.
session: Option<String>
The session which should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth
or AdminRespondToAuthChallenge
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 AdminRespondToAuthChallenge
API call.
Trait Implementations
sourceimpl Clone for AdminInitiateAuthResponse
impl Clone for AdminInitiateAuthResponse
sourcefn clone(&self) -> AdminInitiateAuthResponse
fn clone(&self) -> AdminInitiateAuthResponse
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for AdminInitiateAuthResponse
impl Debug for AdminInitiateAuthResponse
sourceimpl Default for AdminInitiateAuthResponse
impl Default for AdminInitiateAuthResponse
sourcefn default() -> AdminInitiateAuthResponse
fn default() -> AdminInitiateAuthResponse
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for AdminInitiateAuthResponse
impl<'de> Deserialize<'de> for AdminInitiateAuthResponse
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<AdminInitiateAuthResponse> for AdminInitiateAuthResponse
impl PartialEq<AdminInitiateAuthResponse> for AdminInitiateAuthResponse
sourcefn eq(&self, other: &AdminInitiateAuthResponse) -> bool
fn eq(&self, other: &AdminInitiateAuthResponse) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &AdminInitiateAuthResponse) -> bool
fn ne(&self, other: &AdminInitiateAuthResponse) -> bool
This method tests for !=
.
impl StructuralPartialEq for AdminInitiateAuthResponse
Auto Trait Implementations
impl RefUnwindSafe for AdminInitiateAuthResponse
impl Send for AdminInitiateAuthResponse
impl Sync for AdminInitiateAuthResponse
impl Unpin for AdminInitiateAuthResponse
impl UnwindSafe for AdminInitiateAuthResponse
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more