Class: Aws::CognitoIdentityProvider::Types::NewDeviceMetadataType

Inherits:

Struct

Object
Struct
Aws::CognitoIdentityProvider::Types::NewDeviceMetadataType

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Information that your user pool responds with in ‘AuthenticationResult`when you configure it to remember devices and a user signs in with an unrecognized device. Amazon Cognito presents a new device key that you can use to set up [device authentication] in a “Remember me on this device” authentication model.

This data type is a response parameter of authentication operations like [InitiateAuth], [AdminInitiateAuth], [RespondToAuthChallenge], and [AdminRespondToAuthChallenge].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html [4]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html [5]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#device_group_key ⇒ String

The device group key, an identifier used in generating the ‘DEVICE_PASSWORD_VERIFIER` for device SRP authentication.
#device_key ⇒ String

The device key, an identifier used in generating the ‘DEVICE_PASSWORD_VERIFIER` for device SRP authentication.

Instance Attribute Details

#device_group_key ⇒ `String`

The device group key, an identifier used in generating the ‘DEVICE_PASSWORD_VERIFIER` for device SRP authentication.

Returns:

(String)

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

class NewDeviceMetadataType < Struct.new(
  :device_key,
  :device_group_key)
  SENSITIVE = []
  include Aws::Structure
end

#device_key ⇒ `String`

The device key, an identifier used in generating the ‘DEVICE_PASSWORD_VERIFIER` for device SRP authentication.