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.



2027
2028
2029
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2027

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) 


1989
1990
1991
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 1989

def auth_code
  @auth_code
end

#auth_uri ⇒ String

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

Returns:

  • (String) 


1994
1995
1996
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 1994

def auth_uri
  @auth_uri
end

#client_id ⇒ String

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

Returns:

  • (String) 


1999
2000
2001
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 1999

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:



2004
2005
2006
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2004

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) 


2009
2010
2011
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2009

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) 


2015
2016
2017
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2015

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) 


2020
2021
2022
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2020

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>) 


2025
2026
2027
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2025

def scopes
  @scopes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2032

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