You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::InitiateAuthRequest

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

Overview

Note:

When making an API call, you may pass InitiateAuthRequest data as a hash:

{
  auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH
  auth_parameters: {
    "StringType" => "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
  client_id: "ClientIdType", # required
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    encoded_data: "StringType",
  },
}

Initiates the authentication request.

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadataTypes::AnalyticsMetadataType

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



4694
4695
4696
4697
4698
4699
4700
4701
4702
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4694

class InitiateAuthRequest < Struct.new(
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :client_id,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#auth_flowString

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 in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.

  • USER_PASSWORD_AUTH will take in USERNAME and PASSWORD 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_NO_SRP_AUTH is not a valid value.

Returns:

  • (String)


4694
4695
4696
4697
4698
4699
4700
4701
4702
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4694

class InitiateAuthRequest < Struct.new(
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :client_id,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#auth_parametersHash<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 USER_SRP_AUTH: USERNAME (required), SRP_A (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

Returns:

  • (Hash<String,String>)


4694
4695
4696
4697
4698
4699
4700
4701
4702
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4694

class InitiateAuthRequest < Struct.new(
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :client_id,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#client_idString

The app client ID.

Returns:

  • (String)


4694
4695
4696
4697
4698
4699
4700
4701
4702
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4694

class InitiateAuthRequest < Struct.new(
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :client_id,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#client_metadataHash<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.

Returns:

  • (Hash<String,String>)


4694
4695
4696
4697
4698
4699
4700
4701
4702
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4694

class InitiateAuthRequest < Struct.new(
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :client_id,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#user_context_dataTypes::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.



4694
4695
4696
4697
4698
4699
4700
4701
4702
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4694

class InitiateAuthRequest < Struct.new(
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :client_id,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end