Google Cloud Iap V1 Client - Class OAuthSettings (1.3.4)

Version 1.3.4

• 2.0.1 (latest)
• 2.0.0
• 1.4.5
• 1.3.4
• 1.2.3
• 1.1.1
• 1.0.1

Reference documentation and code samples for the Google Cloud Iap V1 Client class OAuthSettings.

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

Generated from protobuf message google.cloud.iap.v1.OAuthSettings

Namespace

Google \ Cloud \ Iap \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ login_hint	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	array List of OAuth client IDs allowed to programmatically authenticate with IAP.

getLoginHint

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
Type	Description
Google\Protobuf\StringValue|null

hasLoginHint

clearLoginHint

getLoginHintValue

Returns the unboxed value from getLoginHint()

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
Type	Description
string|null

setLoginHint

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.

Parameter
Name	Description
var	Google\Protobuf\StringValue

Returns
Type	Description
$this

setLoginHintValue

Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.

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.

Parameter
Name	Description
var	string|null

Returns
Type	Description
$this

getProgrammaticClients

List of OAuth client IDs allowed to programmatically authenticate with IAP.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setProgrammaticClients

List of OAuth client IDs allowed to programmatically authenticate with IAP.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this