Class: Aws::CognitoIdentityProvider::Types::AuthenticationResultType

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

Overview

The authentication result.

Constant Summary collapse

SENSITIVE =
[:access_token, :refresh_token, :id_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

The access token.

Returns:

  • (String)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2428

class AuthenticationResultType < Struct.new(
  :access_token,
  :expires_in,
  :token_type,
  :refresh_token,
  :id_token,
  :new_device_metadata)
  SENSITIVE = [:access_token, :refresh_token, :id_token]
  include Aws::Structure
end

#expires_inInteger

The expiration period of the authentication result in seconds.

Returns:

  • (Integer)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2428

class AuthenticationResultType < Struct.new(
  :access_token,
  :expires_in,
  :token_type,
  :refresh_token,
  :id_token,
  :new_device_metadata)
  SENSITIVE = [:access_token, :refresh_token, :id_token]
  include Aws::Structure
end

#id_tokenString

The ID token.

Returns:

  • (String)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2428

class AuthenticationResultType < Struct.new(
  :access_token,
  :expires_in,
  :token_type,
  :refresh_token,
  :id_token,
  :new_device_metadata)
  SENSITIVE = [:access_token, :refresh_token, :id_token]
  include Aws::Structure
end

#new_device_metadataTypes::NewDeviceMetadataType

The new device metadata from an authentication result.



2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2428

class AuthenticationResultType < Struct.new(
  :access_token,
  :expires_in,
  :token_type,
  :refresh_token,
  :id_token,
  :new_device_metadata)
  SENSITIVE = [:access_token, :refresh_token, :id_token]
  include Aws::Structure
end

#refresh_tokenString

The refresh token.

Returns:

  • (String)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2428

class AuthenticationResultType < Struct.new(
  :access_token,
  :expires_in,
  :token_type,
  :refresh_token,
  :id_token,
  :new_device_metadata)
  SENSITIVE = [:access_token, :refresh_token, :id_token]
  include Aws::Structure
end

#token_typeString

The token type.

Returns:

  • (String)


2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2428

class AuthenticationResultType < Struct.new(
  :access_token,
  :expires_in,
  :token_type,
  :refresh_token,
  :id_token,
  :new_device_metadata)
  SENSITIVE = [:access_token, :refresh_token, :id_token]
  include Aws::Structure
end