Class: Google::Apis::IapV1::OAuthSettings

Inherits:

Object

• Object
• Google::Apis::IapV1::OAuthSettings

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/iap_v1/classes.rb,
generated/google/apis/iap_v1/representations.rb,
generated/google/apis/iap_v1/representations.rb

Overview

Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials.

Instance Attribute Summary

• #client_id ⇒ String

  OAuth 2.0 client ID used in the OAuth flow to generate an access token.

• #login_hint ⇒ String

  Domain hint to send as hd=? parameter in OAuth request flow.

Instance Method Summary

• #initialize(**args) ⇒ OAuthSettings constructor

  A new instance of OAuthSettings.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ OAuthSettings

Returns a new instance of OAuthSettings.

# File 'generated/google/apis/iap_v1/classes.rb', line 540

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

Instance Attribute Details

#client_id ⇒ String

OAuth 2.0 client ID used in the OAuth flow to generate an access token. If this field is set, you can skip obtaining the OAuth credentials in this step: https://developers.google.com/identity/protocols/OAuth2?hl=en_US#1.-obtain- oauth-2.0-credentials-from-the-google-api-console. However, this could allow for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks. Corresponds to the JSON property clientId

Returns:

• (String)

# File 'generated/google/apis/iap_v1/classes.rb', line 529

def client_id
  @client_id
end

#login_hint ⇒ String

Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies. Corresponds to the JSON property loginHint

Returns:

• (String)

# File 'generated/google/apis/iap_v1/classes.rb', line 538

def login_hint
  @login_hint
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/iap_v1/classes.rb', line 545

def update!(**args)
  @client_id = args[:client_id] if args.key?(:client_id)
  @login_hint = args[:login_hint] if args.key?(:login_hint)
end