Class: Aws::SSOOIDC::Types::CreateTokenResponse

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

Overview

See Also:

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

A bearer token to access Amazon Web Services accounts and applications assigned to a user.

Returns:

  • (String) 


188
189
190
191
192
193
194
195
196
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 188

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

#expires_in ⇒ Integer

Indicates the time in seconds when an access token will expire.

Returns:

  • (Integer) 


188
189
190
191
192
193
194
195
196
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 188

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

#id_token ⇒ String

The idToken is not implemented or supported. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.

A JSON Web Token (JWT) that identifies who is associated with the issued access token.

Returns:

  • (String) 


188
189
190
191
192
193
194
195
196
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 188

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

#refresh_token ⇒ String

A token that, if present, can be used to refresh a previously issued access token that might have expired.

For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.

Returns:

  • (String) 


188
189
190
191
192
193
194
195
196
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 188

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

#token_type ⇒ String

Used to notify the client that the returned token is an access token. The supported token type is Bearer.

Returns:

  • (String) 


188
189
190
191
192
193
194
195
196
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 188

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