Package com.google.cloud.iap.v1
Interface OAuthSettingsOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
OAuthSettings,OAuthSettings.Builder
@Generated
public interface OAuthSettingsOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptioncom.google.protobuf.StringValueOptional.com.google.protobuf.StringValueOrBuilderOptional.com.google.protobuf.StringValueOptional.com.google.protobuf.StringValueOrBuilderOptional.com.google.protobuf.StringValueOutput only.com.google.protobuf.StringValueOrBuilderOutput only.com.google.protobuf.StringValueDomain hint to send as hd=?com.google.protobuf.StringValueOrBuilderDomain hint to send as hd=?getProgrammaticClients(int index) Optional.com.google.protobuf.ByteStringgetProgrammaticClientsBytes(int index) Optional.intOptional.Optional.booleanOptional.booleanOptional.booleanOutput only.booleanDomain hint to send as hd=?Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasLoginHint
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:
- Whether the loginHint field is set.
-
getLoginHint
com.google.protobuf.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:
- The loginHint.
-
getLoginHintOrBuilder
com.google.protobuf.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; -
hasClientId
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:
- Whether the clientId field is set.
-
getClientId
com.google.protobuf.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:
- The clientId.
-
getClientIdOrBuilder
com.google.protobuf.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]; -
hasClientSecret
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:
- Whether the clientSecret field is set.
-
getClientSecret
com.google.protobuf.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:
- The clientSecret.
-
getClientSecretOrBuilder
com.google.protobuf.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]; -
hasClientSecretSha256
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:
- Whether the clientSecretSha256 field is set.
-
getClientSecretSha256
com.google.protobuf.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:
- The clientSecretSha256.
-
getClientSecretSha256OrBuilder
com.google.protobuf.StringValueOrBuilder getClientSecretSha256OrBuilder()Output only. OAuth secret SHA256 paired with client ID.
.google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getProgrammaticClientsList
Optional. List of client ids allowed to use IAP programmatically.
repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- A list containing the programmaticClients.
-
getProgrammaticClientsCount
int getProgrammaticClientsCount()Optional. List of client ids allowed to use IAP programmatically.
repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The count of programmaticClients.
-
getProgrammaticClients
Optional. List of client ids allowed to use IAP programmatically.
repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
index- The index of the element to return.- Returns:
- The programmaticClients at the given index.
-
getProgrammaticClientsBytes
com.google.protobuf.ByteString getProgrammaticClientsBytes(int index) Optional. List of client ids allowed to use IAP programmatically.
repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the programmaticClients at the given index.
-