Interface OAuthSettingsOrBuilder (0.44.0)

public interface OAuthSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getClientId()

public abstract StringValue 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.

.google.protobuf.StringValue client_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StringValue

The clientId.

getClientIdOrBuilder()

public abstract StringValueOrBuilder getClientIdOrBuilder()

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.

.google.protobuf.StringValue client_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StringValueOrBuilder

getClientSecret()

public abstract StringValue getClientSecret()

Optional. Input only. OAuth secret paired with client ID.

.google.protobuf.StringValue client_secret = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StringValue

The clientSecret.

getClientSecretOrBuilder()

public abstract StringValueOrBuilder getClientSecretOrBuilder()

Optional. Input only. OAuth secret paired with client ID.

.google.protobuf.StringValue client_secret = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StringValueOrBuilder

getClientSecretSha256()

public abstract StringValue getClientSecretSha256()

Output only. OAuth secret SHA256 paired with client ID.

.google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
StringValue

The clientSecretSha256.

getClientSecretSha256OrBuilder()

public abstract StringValueOrBuilder getClientSecretSha256OrBuilder()

Output only. OAuth secret SHA256 paired with client ID.

.google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
StringValueOrBuilder

getLoginHint()

public abstract StringValue 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.

.google.protobuf.StringValue login_hint = 2;

Returns
Type Description
StringValue

The loginHint.

getLoginHintOrBuilder()

public abstract StringValueOrBuilder getLoginHintOrBuilder()

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.

.google.protobuf.StringValue login_hint = 2;

Returns
Type Description
StringValueOrBuilder

getProgrammaticClients(int index)

public abstract String getProgrammaticClients(int index)

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

repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The programmaticClients at the given index.

getProgrammaticClientsBytes(int index)

public abstract ByteString getProgrammaticClientsBytes(int index)

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

repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the programmaticClients at the given index.

getProgrammaticClientsCount()

public abstract int getProgrammaticClientsCount()

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

repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of programmaticClients.

getProgrammaticClientsList()

public abstract List<String> getProgrammaticClientsList()

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

repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the programmaticClients.

hasClientId()

public abstract boolean hasClientId()

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.

.google.protobuf.StringValue client_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the clientId field is set.

hasClientSecret()

public abstract boolean hasClientSecret()

Optional. Input only. OAuth secret paired with client ID.

.google.protobuf.StringValue client_secret = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the clientSecret field is set.

hasClientSecretSha256()

public abstract boolean hasClientSecretSha256()

Output only. OAuth secret SHA256 paired with client ID.

.google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the clientSecretSha256 field is set.

hasLoginHint()

public abstract boolean hasLoginHint()

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.

.google.protobuf.StringValue login_hint = 2;

Returns
Type Description
boolean

Whether the loginHint field is set.