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

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

Overview

The object that your application receives after authentication. Contains tokens and information for device authentication.

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

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

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

Your user’s access token.

Returns:

  • (String) 


2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2720

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_in ⇒ Integer

The expiration period of the authentication result in seconds.

Returns:

  • (Integer) 


2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2720

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_token ⇒ String

Your user’s ID token.

Returns:

  • (String) 


2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2720

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_metadata ⇒ Types::NewDeviceMetadataType

The new device metadata from an authentication result.

Returns:



2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2720

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_token ⇒ String

Your user’s refresh token.

Returns:

  • (String) 


2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2720

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_type ⇒ String

The intended use of the token, for example ‘Bearer`.

Returns:

  • (String) 


2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2720

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