Struct rusoto_cognito_idp::InitiateAuthRequest

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

Initiates the authentication request.

Fields

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.

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.

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: USERNAME (required), SECRETHASH (required if the app client is configured with a client secret), REFRESHTOKEN (required), 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.

Trait Implementations

impl Default for InitiateAuthRequest

fn default() -> InitiateAuthRequest

Returns the "default value" for a type.

impl Debug for InitiateAuthRequest

fn fmt(&self, __arg_0: &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.