Reference documentation and code samples for the Identity-Aware Proxy V1 API class Google::Cloud::Iap::V1::OAuthSettings.
Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#client_id
def client_id() -> ::Google::Protobuf::StringValue
Returns
- (::Google::Protobuf::StringValue) — Optional. OAuth 2.0 client ID used in the OAuth flow. This allows for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.
#client_id=
def client_id=(value) -> ::Google::Protobuf::StringValue
Parameter
- value (::Google::Protobuf::StringValue) — Optional. OAuth 2.0 client ID used in the OAuth flow. This allows for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.
Returns
- (::Google::Protobuf::StringValue) — Optional. OAuth 2.0 client ID used in the OAuth flow. This allows for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.
#client_secret
def client_secret() -> ::Google::Protobuf::StringValue
Returns
- (::Google::Protobuf::StringValue) — Optional. Input only. OAuth secret paired with client ID.
#client_secret=
def client_secret=(value) -> ::Google::Protobuf::StringValue
Parameter
- value (::Google::Protobuf::StringValue) — Optional. Input only. OAuth secret paired with client ID.
Returns
- (::Google::Protobuf::StringValue) — Optional. Input only. OAuth secret paired with client ID.
#client_secret_sha256
def client_secret_sha256() -> ::Google::Protobuf::StringValue
Returns
- (::Google::Protobuf::StringValue) — Output only. OAuth secret SHA256 paired with client ID.
#login_hint
def login_hint() -> ::Google::Protobuf::StringValue
Returns
- (::Google::Protobuf::StringValue) — 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.
#login_hint=
def login_hint=(value) -> ::Google::Protobuf::StringValue
Parameter
- value (::Google::Protobuf::StringValue) — 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.
Returns
- (::Google::Protobuf::StringValue) — 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.
#programmatic_clients
def programmatic_clients() -> ::Array<::String>
Returns
- (::Array<::String>) — Optional. List of client ids allowed to use IAP programmatically.
#programmatic_clients=
def programmatic_clients=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Optional. List of client ids allowed to use IAP programmatically.
Returns
- (::Array<::String>) — Optional. List of client ids allowed to use IAP programmatically.