Google Cloud Iap V1 Client - Class OAuthSettings (1.1.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

Methods

__construct

Constructor.

Parameters
NameDescription
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.

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
TypeDescription
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
TypeDescription
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
NameDescription
var Google\Protobuf\StringValue
Returns
TypeDescription
$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
NameDescription
var string|null
Returns
TypeDescription
$this