Class: Aws::CognitoIdentityProvider::Types::VerifySoftwareTokenRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:access_token, :session, :user_code]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.

Returns:

  • (String) 


13433
13434
13435
13436
13437
13438
13439
13440
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 13433

class VerifySoftwareTokenRequest < Struct.new(
  :access_token,
  :session,
  :user_code,
  :friendly_device_name)
  SENSITIVE = [:access_token, :session, :user_code]
  include Aws::Structure
end

#friendly_device_name ⇒ String

A friendly name for the device that’s running the TOTP authenticator.

Returns:

  • (String) 


13433
13434
13435
13436
13437
13438
13439
13440
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 13433

class VerifySoftwareTokenRequest < Struct.new(
  :access_token,
  :session,
  :user_code,
  :friendly_device_name)
  SENSITIVE = [:access_token, :session, :user_code]
  include Aws::Structure
end

#session ⇒ String

The session ID from an ‘AssociateSoftwareToken` request.

Returns:

  • (String) 


13433
13434
13435
13436
13437
13438
13439
13440
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 13433

class VerifySoftwareTokenRequest < Struct.new(
  :access_token,
  :session,
  :user_code,
  :friendly_device_name)
  SENSITIVE = [:access_token, :session, :user_code]
  include Aws::Structure
end

#user_code ⇒ String

A TOTP that the user generated in their configured authenticator app.

Returns:

  • (String) 


13433
13434
13435
13436
13437
13438
13439
13440
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 13433

class VerifySoftwareTokenRequest < Struct.new(
  :access_token,
  :session,
  :user_code,
  :friendly_device_name)
  SENSITIVE = [:access_token, :session, :user_code]
  include Aws::Structure
end