Struct rusoto_cognito_idp::AdminRespondToAuthChallengeRequest

pub struct AdminRespondToAuthChallengeRequest {
    pub analytics_metadata: Option<AnalyticsMetadataType>,
    pub challenge_name: String,
    pub challenge_responses: Option<HashMap<String, String>>,
    pub client_id: String,
    pub context_data: Option<ContextDataType>,
    pub session: Option<String>,
    pub user_pool_id: String,
}

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.

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 PartialEq<AdminRespondToAuthChallengeRequest> for AdminRespondToAuthChallengeRequest

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

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

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

This method tests for !=.

impl Default for AdminRespondToAuthChallengeRequest

fn default() -> AdminRespondToAuthChallengeRequest

Returns the "default value" for a type.

impl Clone for AdminRespondToAuthChallengeRequest

fn clone(&self) -> AdminRespondToAuthChallengeRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdminRespondToAuthChallengeRequest

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

Formats the value using the given formatter.

impl Serialize for AdminRespondToAuthChallengeRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.