Class: Aws::Signin::Types::CreateOAuth2TokenRequestBody

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

Overview

Request body payload for CreateOAuth2Token operation

The operation type is determined by the grant_type parameter:

  • grant_type=authorization_code: Requires code, redirect_uri, code_verifier
  • grant_type=refresh_token: Requires refresh_token

See Also:

Constant Summary collapse

SENSITIVE = 
[:refresh_token]

Instance Attribute Summary collapse

Instance Attribute Details

#client_id ⇒ String

The client identifier (ARN) used during Sign-In onboarding Required for both authorization code and refresh token flows

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 133

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

#code ⇒ String

The authorization code received from /v1/authorize Required only when grant_type=authorization_code

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 133

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

#code_verifier ⇒ String

PKCE code verifier to prove possession of the original code challenge Required only when grant_type=authorization_code

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 133

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

#grant_type ⇒ String

OAuth 2.0 grant type - determines which flow is used Must be "authorization_code" or "refresh_token"

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 133

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

#redirect_uri ⇒ String

The redirect URI that must match the original authorization request Required only when grant_type=authorization_code

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 133

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

#refresh_token ⇒ String

The refresh token returned from auth_code redemption Required only when grant_type=refresh_token

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-core/lib/aws-sdk-signin/types.rb', line 133

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