Interface AuthConfig.OidcConfigOrBuilder (3.40.0)

Version 3.40.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static interface AuthConfig.OidcConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIdToken()

public abstract String getIdToken()

OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.

string id_token = 1;

Returns
Type	Description
String	The idToken.

getIdTokenBytes()

public abstract ByteString getIdTokenBytes()

OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.

string id_token = 1;

Returns
Type	Description
ByteString	The bytes for idToken.

getOidcConfigCase()

public abstract AuthConfig.OidcConfig.OidcConfigCase getOidcConfigCase()

Returns
Type	Description
AuthConfig.OidcConfig.OidcConfigCase

getServiceAccount()

public abstract String getServiceAccount()

The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc).

• The audience for the token will be set to the URL in the server url defined in the OpenApi spec.

• If the service account is provided, the service account should grant iam.serviceAccounts.getOpenIdToken permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).

string service_account = 2;

Returns
Type	Description
String	The serviceAccount.

getServiceAccountBytes()

public abstract ByteString getServiceAccountBytes()

The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc).

• The audience for the token will be set to the URL in the server url defined in the OpenApi spec.

• If the service account is provided, the service account should grant iam.serviceAccounts.getOpenIdToken permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).

string service_account = 2;

Returns
Type	Description
ByteString	The bytes for serviceAccount.

hasIdToken()

public abstract boolean hasIdToken()

OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.

string id_token = 1;

Returns
Type	Description
boolean	Whether the idToken field is set.

hasServiceAccount()

public abstract boolean hasServiceAccount()

The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc).

• The audience for the token will be set to the URL in the server url defined in the OpenApi spec.

• If the service account is provided, the service account should grant iam.serviceAccounts.getOpenIdToken permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).

string service_account = 2;

Returns
Type	Description
boolean	Whether the serviceAccount field is set.