Class: Aws::CognitoIdentityProvider::Types::AdminInitiateAuthRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Initiates the authorization request, as an administrator.

See Also:

Constant Summary collapse

SENSITIVE = 
[:client_id, :auth_parameters, :session]

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadata ⇒ Types::AnalyticsMetadataType

Information that supports analytics outcomes with Amazon Pinpoint, including the user’s endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.

Returns:



1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1059

class AdminInitiateAuthRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :analytics_metadata,
  :context_data,
  :session)
  SENSITIVE = [:client_id, :auth_parameters, :session]
  include Aws::Structure
end

#auth_flow ⇒ String

The authentication flow that you want to initiate. Each ‘AuthFlow` has linked `AuthParameters` that you must submit. The following are some example flows.

USER_AUTH

: The entry point for [choice-based authentication] with

passwords, one-time passwords, and WebAuthn authenticators.
Request a preferred authentication type or review available
authentication types. From the offered authentication types,
select one in a challenge response and then authenticate with that
method in an additional challenge response. To activate this
setting, your user pool must be in the [ Essentials tier][2] or
higher.

USER_SRP_AUTH

: Username-password authentication with the Secure Remote Password

(SRP) protocol. For more information, see [Use SRP password
verification in custom authentication flow][3].

REFRESH_TOKEN_AUTH and REFRESH_TOKEN

: Receive new ID and access tokens when you pass a ‘REFRESH_TOKEN`

parameter with a valid refresh token as the value. For more
information, see [Using the refresh token][4].

CUSTOM_AUTH

: Custom authentication with Lambda triggers. For more information,

see [Custom authentication challenge Lambda triggers][5].

ADMIN_USER_PASSWORD_AUTH

: Server-side username-password authentication with the password

sent directly in the request. For more information about
client-side and server-side authentication, see [SDK authorization
models][6].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice [2]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#Using-SRP-password-verification-in-custom-authentication-flow [4]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-the-refresh-token.html [5]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html [6]: docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-public-server-side.html

Returns:

  • (String) 


1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1059

class AdminInitiateAuthRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :analytics_metadata,
  :context_data,
  :session)
  SENSITIVE = [:client_id, :auth_parameters, :session]
  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 example:

  • For ‘USER_AUTH`: `USERNAME` (required), `PREFERRED_CHALLENGE`. If you don’t provide a value for ‘PREFERRED_CHALLENGE`, Amazon Cognito responds with the `AvailableChallenges` parameter that specifies the available sign-in methods.

  • 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 ‘ADMIN_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, include `ChallengeName: SRP_A` and `SRP_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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash [2]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html

Returns:

  • (Hash<String,String>) 


1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1059

class AdminInitiateAuthRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :analytics_metadata,
  :context_data,
  :session)
  SENSITIVE = [:client_id, :auth_parameters, :session]
  include Aws::Structure
end

#client_id ⇒ String

The ID of the app client where the user wants to sign in.

Returns:

  • (String) 


1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1059

class AdminInitiateAuthRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :analytics_metadata,
  :context_data,
  :session)
  SENSITIVE = [:client_id, :auth_parameters, :session]
  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 AdminInitiateAuth 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 AdminInitiateAuth 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 AdminInitiateAuth 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

  • Custom email sender

  • Custom SMS sender

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note 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 send sensitive information in this parameter.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

  • (Hash<String,String>) 


1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1059

class AdminInitiateAuthRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :analytics_metadata,
  :context_data,
  :session)
  SENSITIVE = [:client_id, :auth_parameters, :session]
  include Aws::Structure
end

#context_data ⇒ Types::ContextDataType

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection 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.

For more information, see [Collecting data for threat protection in applications].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html

Returns:



1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1059

class AdminInitiateAuthRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :analytics_metadata,
  :context_data,
  :session)
  SENSITIVE = [:client_id, :auth_parameters, :session]
  include Aws::Structure
end

#session ⇒ String

The optional session ID from a ‘ConfirmSignUp` API request. You can sign in a user directly from the sign-up process with an `AuthFlow` of `USER_AUTH` and `AuthParameters` of `EMAIL_OTP` or `SMS_OTP`, depending on how your user pool sent the confirmation-code message.

Returns:

  • (String) 


1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1059

class AdminInitiateAuthRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :analytics_metadata,
  :context_data,
  :session)
  SENSITIVE = [:client_id, :auth_parameters, :session]
  include Aws::Structure
end

#user_pool_id ⇒ String

The ID of the user pool where the user wants to sign in.

Returns:

  • (String) 


1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1059

class AdminInitiateAuthRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :analytics_metadata,
  :context_data,
  :session)
  SENSITIVE = [:client_id, :auth_parameters, :session]
  include Aws::Structure
end