Google Cloud Iap V1 Client - Class OAuthSettings (2.1.2)

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

Optional. List of client ids allowed to use IAP programmatically.

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

hasLoginHint

clearLoginHint

getLoginHintUnwrapped

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
Returns
Type
Description
$this

setLoginHintUnwrapped

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

Optional. List of client ids allowed to use IAP programmatically.

Returns
Type
Description

setProgrammaticClients

Optional. List of client ids allowed to use IAP programmatically.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: