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 \ V1Methods
__construct
Constructor.
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.
↳ client_id
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
↳ client_secret_sha256
↳ programmatic_clients
string[]
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.
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.
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.
$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.
var
string|null
$this
getClientId
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 .
hasClientId
clearClientId
getClientIdUnwrapped
Returns the unboxed value from getClientId()
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 .
string|null
setClientId
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 .
$this
setClientIdUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.
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 .
var
string|null
$this
getClientSecret
Optional. Input only. OAuth secret paired with client ID.
hasClientSecret
clearClientSecret
getClientSecretUnwrapped
Returns the unboxed value from getClientSecret()
Optional. Input only. OAuth secret paired with client ID.
string|null
setClientSecret
Optional. Input only. OAuth secret paired with client ID.
$this
setClientSecretUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.
Optional. Input only. OAuth secret paired with client ID.
var
string|null
$this
getClientSecretSha256
Output only. OAuth secret SHA256 paired with client ID.
hasClientSecretSha256
clearClientSecretSha256
getClientSecretSha256Unwrapped
Returns the unboxed value from getClientSecretSha256()
Output only. OAuth secret SHA256 paired with client ID.
string|null
setClientSecretSha256
Output only. OAuth secret SHA256 paired with client ID.
$this
setClientSecretSha256Unwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.
Output only. OAuth secret SHA256 paired with client ID.
var
string|null
$this
getProgrammaticClients
Optional. List of client ids allowed to use IAP programmatically.
setProgrammaticClients
Optional. List of client ids allowed to use IAP programmatically.
var
string[]
$this
