Struct rusoto_cognito_idp::AdminInitiateAuthRequest

pub struct AdminInitiateAuthRequest {
    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 context_data: Option<ContextDataType>,
    pub user_pool_id: String,
}

Initiates the authorization request, as an administrator.

Fields

analytics_metadata: Option<AnalyticsMetadataType>

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

auth_flow: String

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

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

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

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

Valid values include:

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

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

• CUSTOMAUTH: Custom authentication flow.

• ADMINNOSRPAUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.

• USERPASSWORDAUTH: 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.

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 ADMINNOSRPAUTH: USERNAME (required), SECRETHASH (if app client is configured with client secret), PASSWORD (required), DEVICEKEY

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

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.

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.

user_pool_id: String

The ID of the Amazon Cognito user pool.

Trait Implementations

impl Default for AdminInitiateAuthRequest

fn default() -> AdminInitiateAuthRequest

Returns the "default value" for a type.

impl Debug for AdminInitiateAuthRequest

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

Formats the value using the given formatter.

impl Clone for AdminInitiateAuthRequest

fn clone(&self) -> AdminInitiateAuthRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for AdminInitiateAuthRequest

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

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

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

This method tests for !=.