Class: Aws::CognitoIdentityProvider::Types::ContextDataType

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

Overview

Contextual user data used for evaluating the risk of an authentication event by user pool threat protection.

This data type is a request parameter of server-side authentication operations like [AdminInitiateAuth] and [AdminRespondToAuthChallenge].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#encoded_data ⇒ String

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see [Adding user device and session data to API requests].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint

Returns:

  • (String) 


3519
3520
3521
3522
3523
3524
3525
3526
3527
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3519

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  SENSITIVE = []
  include Aws::Structure
end

#http_headers ⇒ Array<Types::HttpHeader>

The HTTP headers from your user’s authentication request.

Returns:



3519
3520
3521
3522
3523
3524
3525
3526
3527
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3519

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address ⇒ String

The source IP address of your user’s device.

Returns:

  • (String) 


3519
3520
3521
3522
3523
3524
3525
3526
3527
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3519

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  SENSITIVE = []
  include Aws::Structure
end

#server_name ⇒ String

The name of your application’s service endpoint.

Returns:

  • (String) 


3519
3520
3521
3522
3523
3524
3525
3526
3527
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3519

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  SENSITIVE = []
  include Aws::Structure
end

#server_path ⇒ String

The path of your application’s service endpoint.

Returns:

  • (String) 


3519
3520
3521
3522
3523
3524
3525
3526
3527
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3519

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  SENSITIVE = []
  include Aws::Structure
end