Struct aws_sdk_cognitoidentityprovider::operation::initiate_auth::builders::InitiateAuthFluentBuilder
source · pub struct InitiateAuthFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to InitiateAuth
.
Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP with InitiateAuth
. For more information, see Adding user pool sign-in through a third party.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Implementations§
source§impl InitiateAuthFluentBuilder
impl InitiateAuthFluentBuilder
sourcepub fn as_input(&self) -> &InitiateAuthInputBuilder
pub fn as_input(&self) -> &InitiateAuthInputBuilder
Access the InitiateAuth as a reference.
sourcepub async fn send(
self,
) -> Result<InitiateAuthOutput, SdkError<InitiateAuthError, HttpResponse>>
pub async fn send( self, ) -> Result<InitiateAuthOutput, SdkError<InitiateAuthError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self,
) -> CustomizableOperation<InitiateAuthOutput, InitiateAuthError, Self>
pub fn customize( self, ) -> CustomizableOperation<InitiateAuthOutput, InitiateAuthError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn auth_flow(self, input: AuthFlowType) -> Self
pub fn auth_flow(self, input: AuthFlowType) -> Self
The authentication flow for this call to run. The API action will depend on this value. For example:
-
REFRESH_TOKEN_AUTH
takes in a valid refresh token and returns new tokens. -
USER_SRP_AUTH
takes inUSERNAME
andSRP_A
and returns the SRP variables to be used for next challenge execution. -
USER_PASSWORD_AUTH
takes inUSERNAME
andPASSWORD
and returns 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; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
ADMIN_NO_SRP_AUTH
isn't a valid value.
sourcepub fn set_auth_flow(self, input: Option<AuthFlowType>) -> Self
pub fn set_auth_flow(self, input: Option<AuthFlowType>) -> Self
The authentication flow for this call to run. The API action will depend on this value. For example:
-
REFRESH_TOKEN_AUTH
takes in a valid refresh token and returns new tokens. -
USER_SRP_AUTH
takes inUSERNAME
andSRP_A
and returns the SRP variables to be used for next challenge execution. -
USER_PASSWORD_AUTH
takes inUSERNAME
andPASSWORD
and returns 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; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
ADMIN_NO_SRP_AUTH
isn't a valid value.
sourcepub fn get_auth_flow(&self) -> &Option<AuthFlowType>
pub fn get_auth_flow(&self) -> &Option<AuthFlowType>
The authentication flow for this call to run. The API action will depend on this value. For example:
-
REFRESH_TOKEN_AUTH
takes in a valid refresh token and returns new tokens. -
USER_SRP_AUTH
takes inUSERNAME
andSRP_A
and returns the SRP variables to be used for next challenge execution. -
USER_PASSWORD_AUTH
takes inUSERNAME
andPASSWORD
and returns 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; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
ADMIN_NO_SRP_AUTH
isn't a valid value.
sourcepub fn auth_parameters(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn auth_parameters(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to AuthParameters
.
To override the contents of this collection use set_auth_parameters
.
The authentication parameters. These are inputs corresponding to the AuthFlow
that you're invoking. The required values depend on the value of AuthFlow
:
-
For
USER_SRP_AUTH
:USERNAME
(required),SRP_A
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. -
For
USER_PASSWORD_AUTH
:USERNAME
(required),PASSWORD
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. -
For
REFRESH_TOKEN_AUTH/REFRESH_TOKEN
:REFRESH_TOKEN
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. -
For
CUSTOM_AUTH
:USERNAME
(required),SECRET_HASH
(if app client is configured with client secret),DEVICE_KEY
. To start the authentication flow with password verification, includeChallengeName: SRP_A
andSRP_A: (The SRP_A Value)
.
For more information about SECRET_HASH
, see Computing secret hash values. For information about DEVICE_KEY
, see Working with user devices in your user pool.
sourcepub fn set_auth_parameters(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_auth_parameters(self, input: Option<HashMap<String, String>>) -> Self
The authentication parameters. These are inputs corresponding to the AuthFlow
that you're invoking. The required values depend on the value of AuthFlow
:
-
For
USER_SRP_AUTH
:USERNAME
(required),SRP_A
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. -
For
USER_PASSWORD_AUTH
:USERNAME
(required),PASSWORD
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. -
For
REFRESH_TOKEN_AUTH/REFRESH_TOKEN
:REFRESH_TOKEN
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. -
For
CUSTOM_AUTH
:USERNAME
(required),SECRET_HASH
(if app client is configured with client secret),DEVICE_KEY
. To start the authentication flow with password verification, includeChallengeName: SRP_A
andSRP_A: (The SRP_A Value)
.
For more information about SECRET_HASH
, see Computing secret hash values. For information about DEVICE_KEY
, see Working with user devices in your user pool.
sourcepub fn get_auth_parameters(&self) -> &Option<HashMap<String, String>>
pub fn get_auth_parameters(&self) -> &Option<HashMap<String, String>>
The authentication parameters. These are inputs corresponding to the AuthFlow
that you're invoking. The required values depend on the value of AuthFlow
:
-
For
USER_SRP_AUTH
:USERNAME
(required),SRP_A
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. -
For
USER_PASSWORD_AUTH
:USERNAME
(required),PASSWORD
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. -
For
REFRESH_TOKEN_AUTH/REFRESH_TOKEN
:REFRESH_TOKEN
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. -
For
CUSTOM_AUTH
:USERNAME
(required),SECRET_HASH
(if app client is configured with client secret),DEVICE_KEY
. To start the authentication flow with password verification, includeChallengeName: SRP_A
andSRP_A: (The SRP_A Value)
.
For more information about SECRET_HASH
, see Computing secret hash values. For information about DEVICE_KEY
, see Working with user devices in your user pool.
sourcepub fn client_metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn client_metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to ClientMetadata
.
To override the contents of this collection use set_client_metadata
.
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 Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the 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 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 doesn't provide the ClientMetadata value as input:
-
Post authentication
-
Custom message
-
Pre token generation
-
Create auth challenge
-
Define auth challenge
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
-
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
-
Validate the ClientMetadata value.
-
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
sourcepub fn set_client_metadata(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_client_metadata(self, input: Option<HashMap<String, String>>) -> Self
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 Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the 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 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 doesn't provide the ClientMetadata value as input:
-
Post authentication
-
Custom message
-
Pre token generation
-
Create auth challenge
-
Define auth challenge
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
-
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
-
Validate the ClientMetadata value.
-
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
sourcepub fn get_client_metadata(&self) -> &Option<HashMap<String, String>>
pub fn get_client_metadata(&self) -> &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 Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the 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 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 doesn't provide the ClientMetadata value as input:
-
Post authentication
-
Custom message
-
Pre token generation
-
Create auth challenge
-
Define auth challenge
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
-
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
-
Validate the ClientMetadata value.
-
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
sourcepub fn set_client_id(self, input: Option<String>) -> Self
pub fn set_client_id(self, input: Option<String>) -> Self
The app client ID.
sourcepub fn get_client_id(&self) -> &Option<String>
pub fn get_client_id(&self) -> &Option<String>
The app client ID.
sourcepub fn analytics_metadata(self, input: AnalyticsMetadataType) -> Self
pub fn analytics_metadata(self, input: AnalyticsMetadataType) -> Self
The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth
calls.
sourcepub fn set_analytics_metadata(
self,
input: Option<AnalyticsMetadataType>,
) -> Self
pub fn set_analytics_metadata( self, input: Option<AnalyticsMetadataType>, ) -> Self
The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth
calls.
sourcepub fn get_analytics_metadata(&self) -> &Option<AnalyticsMetadataType>
pub fn get_analytics_metadata(&self) -> &Option<AnalyticsMetadataType>
The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth
calls.
sourcepub fn user_context_data(self, input: UserContextDataType) -> Self
pub fn user_context_data(self, input: UserContextDataType) -> Self
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
sourcepub fn set_user_context_data(self, input: Option<UserContextDataType>) -> Self
pub fn set_user_context_data(self, input: Option<UserContextDataType>) -> Self
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
sourcepub fn get_user_context_data(&self) -> &Option<UserContextDataType>
pub fn get_user_context_data(&self) -> &Option<UserContextDataType>
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
Trait Implementations§
source§impl Clone for InitiateAuthFluentBuilder
impl Clone for InitiateAuthFluentBuilder
source§fn clone(&self) -> InitiateAuthFluentBuilder
fn clone(&self) -> InitiateAuthFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for InitiateAuthFluentBuilder
impl !RefUnwindSafe for InitiateAuthFluentBuilder
impl Send for InitiateAuthFluentBuilder
impl Sync for InitiateAuthFluentBuilder
impl Unpin for InitiateAuthFluentBuilder
impl !UnwindSafe for InitiateAuthFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more