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.



4497
4498
4499
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4497

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

Instance Attribute Details

#auth_code ⇒ String

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

Returns:

  • (String) 


4459
4460
4461
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4459

def auth_code
  @auth_code
end

#auth_uri ⇒ String

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

Returns:

  • (String) 


4464
4465
4466
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4464

def auth_uri
  @auth_uri
end

#client_id ⇒ String

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

Returns:

  • (String) 


4469
4470
4471
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4469

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:



4474
4475
4476
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4474

def client_secret
  @client_secret
end

#enable_pkce ⇒ Boolean Also known as: enable_pkce?

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

Returns:

  • (Boolean) 


4479
4480
4481
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4479

def enable_pkce
  @enable_pkce
end

#pkce_verifier ⇒ String

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

Returns:

  • (String) 


4485
4486
4487
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4485

def pkce_verifier
  @pkce_verifier
end

#redirect_uri ⇒ String

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

Returns:

  • (String) 


4490
4491
4492
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4490

def redirect_uri
  @redirect_uri
end

#scopes ⇒ Array<String>

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

Returns:

  • (Array<String>) 


4495
4496
4497
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4495

def scopes
  @scopes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 4502

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