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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

An opaque token to access Amazon Web Services SSO resources assigned to a user.

Returns:

  • (String)


184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 184

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

#expires_inInteger

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

Returns:

  • (Integer)


184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 184

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

#id_tokenString

Currently, idToken is not yet implemented and is not supported. For more information about the features and limitations of the current Amazon Web Services SSO OIDC implementation, see Considerations for Using this Guide in the Amazon Web Services SSO OIDC API Reference.

The identifier of the user that associated with the access token, if present.

Returns:

  • (String)


184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 184

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

#refresh_tokenString

Currently, refreshToken is not yet implemented and is not supported. For more information about the features and limitations of the current Amazon Web Services SSO OIDC implementation, see Considerations for Using this Guide in the Amazon Web Services SSO OIDC API Reference.

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

Returns:

  • (String)


184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 184

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

#token_typeString

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

Returns:

  • (String)


184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-ssooidc/lib/aws-sdk-ssooidc/types.rb', line 184

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