Class: Aws::SSOOIDC::Types::CreateTokenWithIAMRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:refresh_token, :assertion, :subject_token]

Instance Attribute Summary collapse

Method Summary

Methods included from Aws::Structure

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

Instance Attribute Details

#assertion ⇒ String

Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.

Returns:

  • (String) 


283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-ssooidc/types.rb', line 283

class CreateTokenWithIAMRequest < Struct.new(
  :client_id,
  :grant_type,
  :code,
  :refresh_token,
  :assertion,
  :scope,
  :redirect_uri,
  :subject_token,
  :subject_token_type,
  :requested_token_type)
  SENSITIVE = [:refresh_token, :assertion, :subject_token]
  include Aws::Structure
end

#client_id ⇒ String

The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.

Returns:

  • (String) 


283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-ssooidc/types.rb', line 283

class CreateTokenWithIAMRequest < Struct.new(
  :client_id,
  :grant_type,
  :code,
  :refresh_token,
  :assertion,
  :scope,
  :redirect_uri,
  :subject_token,
  :subject_token_type,
  :requested_token_type)
  SENSITIVE = [:refresh_token, :assertion, :subject_token]
  include Aws::Structure
end

#code ⇒ String

Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.

Returns:

  • (String) 


283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-ssooidc/types.rb', line 283

class CreateTokenWithIAMRequest < Struct.new(
  :client_id,
  :grant_type,
  :code,
  :refresh_token,
  :assertion,
  :scope,
  :redirect_uri,
  :subject_token,
  :subject_token_type,
  :requested_token_type)
  SENSITIVE = [:refresh_token, :assertion, :subject_token]
  include Aws::Structure
end

#grant_type ⇒ String

Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:

  • Authorization Code - ‘authorization_code`

  • Refresh Token - ‘refresh_token`

  • JWT Bearer - ‘urn:ietf:params:oauth:grant-type:jwt-bearer`

  • Token Exchange -

‘urn:ietf:params:oauth:grant-type:token-exchange`

Returns:

  • (String) 


283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-ssooidc/types.rb', line 283

class CreateTokenWithIAMRequest < Struct.new(
  :client_id,
  :grant_type,
  :code,
  :refresh_token,
  :assertion,
  :scope,
  :redirect_uri,
  :subject_token,
  :subject_token_type,
  :requested_token_type)
  SENSITIVE = [:refresh_token, :assertion, :subject_token]
  include Aws::Structure
end

#redirect_uri ⇒ String

Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.

Returns:

  • (String) 


283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-ssooidc/types.rb', line 283

class CreateTokenWithIAMRequest < Struct.new(
  :client_id,
  :grant_type,
  :code,
  :refresh_token,
  :assertion,
  :scope,
  :redirect_uri,
  :subject_token,
  :subject_token_type,
  :requested_token_type)
  SENSITIVE = [:refresh_token, :assertion, :subject_token]
  include Aws::Structure
end

#refresh_token ⇒ String

Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term tokens, such as the access token, that might expire.

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) 


283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-ssooidc/types.rb', line 283

class CreateTokenWithIAMRequest < Struct.new(
  :client_id,
  :grant_type,
  :code,
  :refresh_token,
  :assertion,
  :scope,
  :redirect_uri,
  :subject_token,
  :subject_token_type,
  :requested_token_type)
  SENSITIVE = [:refresh_token, :assertion, :subject_token]
  include Aws::Structure
end

#requested_token_type ⇒ String

Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. 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) 


283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-ssooidc/types.rb', line 283

class CreateTokenWithIAMRequest < Struct.new(
  :client_id,
  :grant_type,
  :code,
  :refresh_token,
  :assertion,
  :scope,
  :redirect_uri,
  :subject_token,
  :subject_token_type,
  :requested_token_type)
  SENSITIVE = [:refresh_token, :assertion, :subject_token]
  include Aws::Structure
end

#scope ⇒ Array<String>

The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: ‘openid`, `aws`, `sts:identity_context`.

Returns:

  • (Array<String>) 


283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-ssooidc/types.rb', line 283

class CreateTokenWithIAMRequest < Struct.new(
  :client_id,
  :grant_type,
  :code,
  :refresh_token,
  :assertion,
  :scope,
  :redirect_uri,
  :subject_token,
  :subject_token_type,
  :requested_token_type)
  SENSITIVE = [:refresh_token, :assertion, :subject_token]
  include Aws::Structure
end

#subject_token ⇒ String

Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.

Returns:

  • (String) 


283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-ssooidc/types.rb', line 283

class CreateTokenWithIAMRequest < Struct.new(
  :client_id,
  :grant_type,
  :code,
  :refresh_token,
  :assertion,
  :scope,
  :redirect_uri,
  :subject_token,
  :subject_token_type,
  :requested_token_type)
  SENSITIVE = [:refresh_token, :assertion, :subject_token]
  include Aws::Structure
end

#subject_token_type ⇒ String

Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:

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

Returns:

  • (String) 


283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aws-sdk-ssooidc/types.rb', line 283

class CreateTokenWithIAMRequest < Struct.new(
  :client_id,
  :grant_type,
  :code,
  :refresh_token,
  :assertion,
  :scope,
  :redirect_uri,
  :subject_token,
  :subject_token_type,
  :requested_token_type)
  SENSITIVE = [:refresh_token, :assertion, :subject_token]
  include Aws::Structure
end