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

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

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 AdminInitiateAuthRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
  auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH
  auth_parameters: {
    "StringType" => "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  context_data: {
    ip_address: "StringType", # required
    server_name: "StringType", # required
    server_path: "StringType", # required
    http_headers: [ # required
      {
        header_name: "StringType",
        header_value: "StringType",
      },
    ],
    encoded_data: "StringType",
  },
}

Initiates the authorization request, as an administrator.

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadataTypes::AnalyticsMetadataType

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



914
915
916
917
918
919
920
921
922
923
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 914

class AdminInitiateAuthRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :analytics_metadata,
  :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.

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.

  • ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.

Returns:

  • (String)


914
915
916
917
918
919
920
921
922
923
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 914

class AdminInitiateAuthRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :analytics_metadata,
  :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: USERNAME (required), SECRET_HASH (required if the app client is configured with a client secret), REFRESH_TOKEN (required), DEVICE_KEY

  • For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY

  • For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY

Returns:

  • (Hash<String,String>)


914
915
916
917
918
919
920
921
922
923
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 914

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

#client_idString

The app client ID.

Returns:

  • (String)


914
915
916
917
918
919
920
921
922
923
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 914

class AdminInitiateAuthRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :auth_flow,
  :auth_parameters,
  :client_metadata,
  :analytics_metadata,
  :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>)


914
915
916
917
918
919
920
921
922
923
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 914

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

#context_dataTypes::ContextDataType

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.



914
915
916
917
918
919
920
921
922
923
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 914

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

#user_pool_idString

The ID of the Amazon Cognito user pool.

Returns:

  • (String)


914
915
916
917
918
919
920
921
922
923
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 914

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