Class: Aws::CognitoIdentityProvider::Types::UserContextDataType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::UserContextDataType

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

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

{
  ip_address: "StringType",
  encoded_data: "StringType",
}

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #encoded_data ⇒ String

  Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library.

• #ip_address ⇒ String

  The source IP address of your user's device.

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)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10303

class UserContextDataType < Struct.new(
  :ip_address,
  :encoded_data)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address ⇒ String

The source IP address of your user's device.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10303

class UserContextDataType < Struct.new(
  :ip_address,
  :encoded_data)
  SENSITIVE = []
  include Aws::Structure
end