Class: Google::Apis::ConnectorsV1::Oauth2AuthCodeFlow

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/connectors_v1/classes.rb,
lib/google/apis/connectors_v1/representations.rb,
lib/google/apis/connectors_v1/representations.rb

Overview

Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https:// www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Oauth2AuthCodeFlow

Returns a new instance of Oauth2AuthCodeFlow.



5342
5343
5344
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 5342

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#auth_code ⇒ String

Optional. Authorization code to be exchanged for access and refresh tokens. Corresponds to the JSON property authCode

Returns:

  • (String) 


5303
5304
5305
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 5303

def auth_code
  @auth_code
end

#auth_uri ⇒ String

Optional. Auth URL for Authorization Code Flow Corresponds to the JSON property authUri

Returns:

  • (String) 


5308
5309
5310
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 5308

def auth_uri
  @auth_uri
end

#client_id ⇒ String

Optional. Client ID for user-provided OAuth app. Corresponds to the JSON property clientId

Returns:

  • (String) 


5313
5314
5315
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 5313

def client_id
  @client_id
end

#client_secret ⇒ Google::Apis::ConnectorsV1::Secret

Secret provides a reference to entries in Secret Manager. Corresponds to the JSON property clientSecret

Returns:



5318
5319
5320
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 5318

def client_secret
  @client_secret
end

#enable_pkce ⇒ Boolean Also known as: enable_pkce?

Optional. Whether to enable PKCE when the user performs the auth code flow. Corresponds to the JSON property enablePkce

Returns:

  • (Boolean) 


5323
5324
5325
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 5323

def enable_pkce
  @enable_pkce
end

#pkce_verifier ⇒ String

Optional. PKCE verifier to be used during the auth code exchange. Corresponds to the JSON property pkceVerifier

Returns:

  • (String) 


5329
5330
5331
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 5329

def pkce_verifier
  @pkce_verifier
end

#redirect_uri ⇒ String

Optional. Redirect URI to be provided during the auth code exchange. Corresponds to the JSON property redirectUri

Returns:

  • (String) 


5334
5335
5336
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 5334

def redirect_uri
  @redirect_uri
end

#scopes ⇒ Array<String>

Optional. Scopes the connection will request when the user performs the auth code flow. Corresponds to the JSON property scopes

Returns:

  • (Array<String>) 


5340
5341
5342
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 5340

def scopes
  @scopes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 5347

def update!(**args)
  @auth_code = args[:auth_code] if args.key?(:auth_code)
  @auth_uri = args[:auth_uri] if args.key?(:auth_uri)
  @client_id = args[:client_id] if args.key?(:client_id)
  @client_secret = args[:client_secret] if args.key?(:client_secret)
  @enable_pkce = args[:enable_pkce] if args.key?(:enable_pkce)
  @pkce_verifier = args[:pkce_verifier] if args.key?(:pkce_verifier)
  @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
  @scopes = args[:scopes] if args.key?(:scopes)
end