Class: Aws::CognitoIdentityProvider::Types::InitiateAuthRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::InitiateAuthRequest
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
Initiates the authentication request.
Constant Summary collapse
- SENSITIVE =
[:auth_parameters, :client_id, :user_context_data]
Instance Attribute Summary collapse
-
#analytics_metadata ⇒ Types::AnalyticsMetadataType
The Amazon Pinpoint analytics metadata that contributes to your metrics for
InitiateAuth
calls. -
#auth_flow ⇒ String
The authentication flow for this call to run.
-
#auth_parameters ⇒ Hash<String,String>
The authentication parameters.
-
#client_id ⇒ String
The app client ID.
-
#client_metadata ⇒ Hash<String,String>
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
-
#user_context_data ⇒ Types::UserContextDataType
Contextual data about your user session, such as the device fingerprint, IP address, or location.
Instance Attribute Details
#analytics_metadata ⇒ Types::AnalyticsMetadataType
The Amazon Pinpoint analytics metadata that contributes to your
metrics for InitiateAuth
calls.
5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5568 class InitiateAuthRequest < Struct.new( :auth_flow, :auth_parameters, :client_metadata, :client_id, :analytics_metadata, :user_context_data) SENSITIVE = [:auth_parameters, :client_id, :user_context_data] include Aws::Structure end |
#auth_flow ⇒ String
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.
5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5568 class InitiateAuthRequest < Struct.new( :auth_flow, :auth_parameters, :client_metadata, :client_id, :analytics_metadata, :user_context_data) SENSITIVE = [:auth_parameters, :client_id, :user_context_data] include Aws::Structure end |
#auth_parameters ⇒ Hash<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.
5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5568 class InitiateAuthRequest < Struct.new( :auth_flow, :auth_parameters, :client_metadata, :client_id, :analytics_metadata, :user_context_data) SENSITIVE = [:auth_parameters, :client_id, :user_context_data] include Aws::Structure end |
#client_id ⇒ String
The app client ID.
5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5568 class InitiateAuthRequest < Struct.new( :auth_flow, :auth_parameters, :client_metadata, :client_id, :analytics_metadata, :user_context_data) SENSITIVE = [:auth_parameters, :client_id, :user_context_data] include Aws::Structure end |
#client_metadata ⇒ Hash<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.
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.
5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5568 class InitiateAuthRequest < Struct.new( :auth_flow, :auth_parameters, :client_metadata, :client_id, :analytics_metadata, :user_context_data) SENSITIVE = [:auth_parameters, :client_id, :user_context_data] include Aws::Structure end |
#user_context_data ⇒ Types::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.
5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5568 class InitiateAuthRequest < Struct.new( :auth_flow, :auth_parameters, :client_metadata, :client_id, :analytics_metadata, :user_context_data) SENSITIVE = [:auth_parameters, :client_id, :user_context_data] include Aws::Structure end |