[−][src]Struct rusoto_cognito_idp::AdminRespondToAuthChallengeRequest
The request to respond to the authentication challenge, as an administrator.
Fields
analytics_metadata: Option<AnalyticsMetadataType>
The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge
calls.
challenge_name: String
The challenge name. For more information, see .
challenge_responses: Option<HashMap<String, String>>
The challenge responses. These are inputs corresponding to the value of ChallengeName
, for example:
-
SMS_MFA
:SMS_MFA_CODE
,USERNAME
,SECRET_HASH
(if app client is configured with client secret). -
PASSWORD_VERIFIER
:PASSWORD_CLAIM_SIGNATURE
,PASSWORD_CLAIM_SECRET_BLOCK
,TIMESTAMP
,USERNAME
,SECRET_HASH
(if app client is configured with client secret). -
ADMIN_NO_SRP_AUTH
:PASSWORD
,USERNAME
,SECRET_HASH
(if app client is configured with client secret). -
NEW_PASSWORD_REQUIRED
:NEW_PASSWORD
, any other required attributes,USERNAME
,SECRET_HASH
(if app client is configured with client secret).
The value of the USERNAME
attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth
response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute, even if you specified an alias in your call to AdminInitiateAuth
.
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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, post authentication, user migration, pre token generation, define auth challenge, create auth challenge, and verify auth challenge response. 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 AdminRespondToAuthChallenge 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.
context_data: Option<ContextDataType>
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.
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_pool_id: String
The ID of the Amazon Cognito user pool.
Trait Implementations
impl Clone for AdminRespondToAuthChallengeRequest
[src]
pub fn clone(&self) -> AdminRespondToAuthChallengeRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for AdminRespondToAuthChallengeRequest
[src]
impl Default for AdminRespondToAuthChallengeRequest
[src]
pub fn default() -> AdminRespondToAuthChallengeRequest
[src]
impl PartialEq<AdminRespondToAuthChallengeRequest> for AdminRespondToAuthChallengeRequest
[src]
pub fn eq(&self, other: &AdminRespondToAuthChallengeRequest) -> bool
[src]
pub fn ne(&self, other: &AdminRespondToAuthChallengeRequest) -> bool
[src]
impl Serialize for AdminRespondToAuthChallengeRequest
[src]
pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralPartialEq for AdminRespondToAuthChallengeRequest
[src]
Auto Trait Implementations
impl RefUnwindSafe for AdminRespondToAuthChallengeRequest
[src]
impl Send for AdminRespondToAuthChallengeRequest
[src]
impl Sync for AdminRespondToAuthChallengeRequest
[src]
impl Unpin for AdminRespondToAuthChallengeRequest
[src]
impl UnwindSafe for AdminRespondToAuthChallengeRequest
[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>,