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
#login_hint
deflogin_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.
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
defprogrammatic_clients()->::Array<::String>
Returns
(::Array<::String>) — Optional. List of client ids allowed to use IAP programmatically.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Identity-Aware Proxy V1 API - Class Google::Cloud::Iap::V1::OAuthSettings (v1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/ruby/docs/reference/google-cloud-iap-v1/latest/Google-Cloud-Iap-V1-OAuthSettings)\n- [1.4.0](/ruby/docs/reference/google-cloud-iap-v1/1.4.0/Google-Cloud-Iap-V1-OAuthSettings)\n- [1.3.1](/ruby/docs/reference/google-cloud-iap-v1/1.3.1/Google-Cloud-Iap-V1-OAuthSettings)\n- [1.2.0](/ruby/docs/reference/google-cloud-iap-v1/1.2.0/Google-Cloud-Iap-V1-OAuthSettings)\n- [1.1.0](/ruby/docs/reference/google-cloud-iap-v1/1.1.0/Google-Cloud-Iap-V1-OAuthSettings)\n- [1.0.1](/ruby/docs/reference/google-cloud-iap-v1/1.0.1/Google-Cloud-Iap-V1-OAuthSettings)\n- [0.12.0](/ruby/docs/reference/google-cloud-iap-v1/0.12.0/Google-Cloud-Iap-V1-OAuthSettings)\n- [0.11.2](/ruby/docs/reference/google-cloud-iap-v1/0.11.2/Google-Cloud-Iap-V1-OAuthSettings)\n- [0.10.1](/ruby/docs/reference/google-cloud-iap-v1/0.10.1/Google-Cloud-Iap-V1-OAuthSettings)\n- [0.9.0](/ruby/docs/reference/google-cloud-iap-v1/0.9.0/Google-Cloud-Iap-V1-OAuthSettings)\n- [0.8.1](/ruby/docs/reference/google-cloud-iap-v1/0.8.1/Google-Cloud-Iap-V1-OAuthSettings)\n- [0.7.0](/ruby/docs/reference/google-cloud-iap-v1/0.7.0/Google-Cloud-Iap-V1-OAuthSettings)\n- [0.6.0](/ruby/docs/reference/google-cloud-iap-v1/0.6.0/Google-Cloud-Iap-V1-OAuthSettings)\n- [0.5.0](/ruby/docs/reference/google-cloud-iap-v1/0.5.0/Google-Cloud-Iap-V1-OAuthSettings)\n- [0.4.0](/ruby/docs/reference/google-cloud-iap-v1/0.4.0/Google-Cloud-Iap-V1-OAuthSettings)\n- [0.3.0](/ruby/docs/reference/google-cloud-iap-v1/0.3.0/Google-Cloud-Iap-V1-OAuthSettings)\n- [0.2.0](/ruby/docs/reference/google-cloud-iap-v1/0.2.0/Google-Cloud-Iap-V1-OAuthSettings)\n- [0.1.3](/ruby/docs/reference/google-cloud-iap-v1/0.1.3/Google-Cloud-Iap-V1-OAuthSettings) \nReference documentation and code samples for the Identity-Aware Proxy V1 API class Google::Cloud::Iap::V1::OAuthSettings.\n\nConfiguration for OAuth login\\&consent flow behavior as well as for OAuth\nCredentials. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #login_hint\n\n def login_hint() -\u003e ::Google::Protobuf::StringValue\n\n**Returns**\n\n- ([::Google::Protobuf::StringValue](./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.\n\n### #login_hint=\n\n def login_hint=(value) -\u003e ::Google::Protobuf::StringValue\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::StringValue](./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. \n**Returns**\n\n- ([::Google::Protobuf::StringValue](./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.\n\n### #programmatic_clients\n\n def programmatic_clients() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. List of client ids allowed to use IAP programmatically.\n\n### #programmatic_clients=\n\n def programmatic_clients=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- Optional. List of client ids allowed to use IAP programmatically. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. List of client ids allowed to use IAP programmatically."]]
