[−][src]Struct rusoto_cognito_idp::RespondToAuthChallengeRequest
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 .
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
andSOFTWARETOKENMFACODE
are required attributes. -
DEVICESRPAUTH
requiresUSERNAME
,DEVICEKEY
,SRPA
(andSECRETHASH
). -
DEVICEPASSWORDVERIFIER
requires everything thatPASSWORDVERIFIER
requires plusDEVICE_KEY
.
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
[src]
pub fn clone(&self) -> RespondToAuthChallengeRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for RespondToAuthChallengeRequest
[src]
impl Default for RespondToAuthChallengeRequest
[src]
pub fn default() -> RespondToAuthChallengeRequest
[src]
impl PartialEq<RespondToAuthChallengeRequest> for RespondToAuthChallengeRequest
[src]
pub fn eq(&self, other: &RespondToAuthChallengeRequest) -> bool
[src]
pub fn ne(&self, other: &RespondToAuthChallengeRequest) -> bool
[src]
impl Serialize for RespondToAuthChallengeRequest
[src]
pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralPartialEq for RespondToAuthChallengeRequest
[src]
Auto Trait Implementations
impl RefUnwindSafe for RespondToAuthChallengeRequest
[src]
impl Send for RespondToAuthChallengeRequest
[src]
impl Sync for RespondToAuthChallengeRequest
[src]
impl Unpin for RespondToAuthChallengeRequest
[src]
impl UnwindSafe for RespondToAuthChallengeRequest
[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> 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>,