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

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

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

{
  access_token: "TokenModelType",
  session: "SessionType",
  user_code: "SoftwareTokenMFAUserCodeType", # required
  friendly_device_name: "StringType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

The access token.

Returns:

  • (String)


7649
7650
7651
7652
7653
7654
7655
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7649

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

#friendly_device_nameString

The friendly device name.

Returns:

  • (String)


7649
7650
7651
7652
7653
7654
7655
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7649

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

#sessionString

The session which should be passed both ways in challenge-response calls to the service.

Returns:

  • (String)


7649
7650
7651
7652
7653
7654
7655
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7649

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

#user_codeString

The one time password computed using the secret code returned by

Returns:

  • (String)


7649
7650
7651
7652
7653
7654
7655
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7649

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