Struct rusoto_cognito_idp::InitiateAuthRequest
source · [−]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>,
}
Expand description
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 inUSERNAME
andSRP_A
and return the SRP variables to be used for next challenge execution. -
USER_PASSWORD_AUTH
will take inUSERNAME
andPASSWORD
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_USER_PASSWORD_AUTH
: Admin-based user password authentication. This replaces theADMIN_NO_SRP_AUTH
authentication flow. In this flow, Cognito receives the password in the request instead of using the SRP process to verify passwords.
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
. To start the authentication flow with password verification, includeChallengeName: SRPA
andSRPA: (The SRP_A Value)
.
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 certain custom workflows that this action triggers.
You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
-
Pre signup
-
Pre authentication
-
User migration
When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData
attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in AWS Lambda, you can process the validationData
value to enhance your workflow for your specific needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it does not provide the ClientMetadata value as input:
-
Post authentication
-
Custom message
-
Pre token generation
-
Create auth challenge
-
Define auth challenge
-
Verify auth challenge
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.
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
sourceimpl Clone for InitiateAuthRequest
impl Clone for InitiateAuthRequest
sourcefn clone(&self) -> InitiateAuthRequest
fn clone(&self) -> InitiateAuthRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for InitiateAuthRequest
impl Debug for InitiateAuthRequest
sourceimpl Default for InitiateAuthRequest
impl Default for InitiateAuthRequest
sourcefn default() -> InitiateAuthRequest
fn default() -> InitiateAuthRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<InitiateAuthRequest> for InitiateAuthRequest
impl PartialEq<InitiateAuthRequest> for InitiateAuthRequest
sourcefn eq(&self, other: &InitiateAuthRequest) -> bool
fn eq(&self, other: &InitiateAuthRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &InitiateAuthRequest) -> bool
fn ne(&self, other: &InitiateAuthRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for InitiateAuthRequest
impl Serialize for InitiateAuthRequest
impl StructuralPartialEq for InitiateAuthRequest
Auto Trait Implementations
impl RefUnwindSafe for InitiateAuthRequest
impl Send for InitiateAuthRequest
impl Sync for InitiateAuthRequest
impl Unpin for InitiateAuthRequest
impl UnwindSafe for InitiateAuthRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more