Class: Aws::SSOOIDC::Types::CreateTokenRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:client_secret, :refresh_token, :code_verifier]

Instance Attribute Summary collapse

Instance Attribute Details

#client_id ⇒ String

The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 156

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri,
  :code_verifier)
  SENSITIVE = [:client_secret, :refresh_token, :code_verifier]
  include Aws::Structure
end

#client_secret ⇒ String

A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 156

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri,
  :code_verifier)
  SENSITIVE = [:client_secret, :refresh_token, :code_verifier]
  include Aws::Structure
end

#code ⇒ String

Used only when calling this API for the Authorization Code grant type. The short-lived code is used to identify this authorization request.

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 156

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri,
  :code_verifier)
  SENSITIVE = [:client_secret, :refresh_token, :code_verifier]
  include Aws::Structure
end

#code_verifier ⇒ String

Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 156

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri,
  :code_verifier)
  SENSITIVE = [:client_secret, :refresh_token, :code_verifier]
  include Aws::Structure
end

#device_code ⇒ String

Used only when calling this API for the Device Code grant type. This short-lived code is used to identify this authorization request. This comes from the result of the StartDeviceAuthorization API.

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 156

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri,
  :code_verifier)
  SENSITIVE = [:client_secret, :refresh_token, :code_verifier]
  include Aws::Structure
end

#grant_type ⇒ String

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

  • Authorization Code - authorization_code

  • Device Code - urn:ietf:params:oauth:grant-type:device_code

  • Refresh Token - refresh_token

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 156

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri,
  :code_verifier)
  SENSITIVE = [:client_secret, :refresh_token, :code_verifier]
  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) 


156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 156

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri,
  :code_verifier)
  SENSITIVE = [:client_secret, :refresh_token, :code_verifier]
  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-lived 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.

Returns:

  • (String) 


156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 156

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri,
  :code_verifier)
  SENSITIVE = [:client_secret, :refresh_token, :code_verifier]
  include Aws::Structure
end

#scope ⇒ Array<String>

The list of scopes for which authorization is requested. This parameter has no effect; the access token will always include all scopes configured during client registration.

Returns:

  • (Array<String>) 


156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 156

class CreateTokenRequest < Struct.new(
  :client_id,
  :client_secret,
  :grant_type,
  :device_code,
  :code,
  :refresh_token,
  :scope,
  :redirect_uri,
  :code_verifier)
  SENSITIVE = [:client_secret, :refresh_token, :code_verifier]
  include Aws::Structure
end