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

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.

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

The access token.

Returns:

  • (String)


2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2001

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

#expires_inInteger

The expiration period of the authentication result in seconds.

Returns:

  • (Integer)


2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2001

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

#id_tokenString

The ID token.

Returns:

  • (String)


2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2001

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

#new_device_metadataTypes::NewDeviceMetadataType

The new device metadata from an authentication result.



2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2001

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

#refresh_tokenString

The refresh token.

Returns:

  • (String)


2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2001

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

#token_typeString

The token type.

Returns:

  • (String)


2001
2002
2003
2004
2005
2006
2007
2008
2009
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2001

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