Struct rusoto_cognito_idp::InitiateAuthRequest

pub struct InitiateAuthRequest {
    pub analytics_metadata: Option<AnalyticsMetadataType>,
    pub auth_flow: String,
    pub auth_parameters: Option<HashMap<String, String>>,
    pub client_id: String,
    pub client_metadata: Option<HashMap<String, String>>,
    pub user_context_data: Option<UserContextDataType>,
}

Initiates the authentication request.

Fields

analytics_metadata: Option<AnalyticsMetadataType>

The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth calls.

auth_flow: String

The authentication flow for this call to execute. The API action will depend on this value. For example:

• REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.

• USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.

Valid values include:

• USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

• REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

• CUSTOM_AUTH: Custom authentication flow.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.

ADMIN_NO_SRP_AUTH is not a valid value.

auth_parameters: Option<HashMap<String, String>>

The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:

• For USERSRPAUTH: USERNAME (required), SRPA (required), SECRETHASH (required if the app client is configured with a client secret), DEVICEKEY

• For REFRESHTOKENAUTH/REFRESHTOKEN: REFRESHTOKEN (required), SECRETHASH (required if the app client is configured with a client secret), DEVICEKEY

• For CUSTOMAUTH: USERNAME (required), SECRETHASH (if app client is configured with client secret), DEVICEKEY

client_id: String

The app client ID.

client_metadata: Option<HashMap<String, String>>

This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.

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 Default for InitiateAuthRequest

fn default() -> InitiateAuthRequest

Returns the "default value" for a type.

impl Debug for InitiateAuthRequest

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

Formats the value using the given formatter.

impl Clone for InitiateAuthRequest

fn clone(&self) -> InitiateAuthRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for InitiateAuthRequest

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

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

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

This method tests for !=.