Class: Aws::SSOOIDC::Types::CreateTokenWithIAMResponse

Inherits:

Struct

• Object
• Struct
• Aws::SSOOIDC::Types::CreateTokenWithIAMResponse

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssooidc/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:access_token, :refresh_token, :id_token]

Instance Attribute Summary

• #access_token ⇒ String

  A bearer token to access AWS accounts and applications assigned to a user.

• #expires_in ⇒ Integer

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

• #id_token ⇒ String

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

• #issued_token_type ⇒ String

  Indicates the type of tokens that are issued by IAM Identity Center.

• #refresh_token ⇒ String

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

• #scope ⇒ Array<String>

  The list of scopes for which authorization is granted.

• #token_type ⇒ String

  Used to notify the requester that the returned token is an access token.

Method Summary

Methods included from Aws::Structure

#empty?, included, #initialize, #key?, new, #to_h, #to_s

Instance Attribute Details

#access_token ⇒ String

A bearer token to access AWS accounts and applications assigned to a user.

Returns:

• (String)

# File 'lib/aws-sdk-ssooidc/types.rb', line 347

class CreateTokenWithIAMResponse < Struct.new(
  :access_token,
  :token_type,
  :expires_in,
  :refresh_token,
  :id_token,
  :issued_token_type,
  :scope)
  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)

# File 'lib/aws-sdk-ssooidc/types.rb', line 347

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

#id_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ssooidc/types.rb', line 347

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

#issued_token_type ⇒ String

Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:

• Access Token - ‘urn:ietf:params:oauth:token-type:access_token`

• Refresh Token - ‘urn:ietf:params:oauth:token-type:refresh_token`

Returns:

• (String)

# File 'lib/aws-sdk-ssooidc/types.rb', line 347

class CreateTokenWithIAMResponse < Struct.new(
  :access_token,
  :token_type,
  :expires_in,
  :refresh_token,
  :id_token,
  :issued_token_type,
  :scope)
  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].

[1]: docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html

Returns:

• (String)

# File 'lib/aws-sdk-ssooidc/types.rb', line 347

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

#scope ⇒ Array<String>

The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ssooidc/types.rb', line 347

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

#token_type ⇒ String

Used to notify the requester that the returned token is an access token. The supported token type is ‘Bearer`.

Returns:

• (String)

# File 'lib/aws-sdk-ssooidc/types.rb', line 347

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