Package com.google.genai.types

Class AuthConfigOidcConfig

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.AuthConfigOidcConfig

public abstract class AuthConfigOidcConfig
extends JsonSerializable

Config for user OIDC auth.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthConfigOidcConfig.Builder	Builder for AuthConfigOidcConfig.

Constructor Summary

Constructors

Constructor	Description
AuthConfigOidcConfig()

Method Summary

Modifier and Type	Method	Description
static AuthConfigOidcConfig.Builder	builder()	Instantiates a builder for AuthConfigOidcConfig.
static AuthConfigOidcConfig	fromJson(String jsonString)	Deserializes a JSON string to a AuthConfigOidcConfig object.
abstract Optional<String>	idToken()	OpenID Connect formatted ID token for extension endpoint.
abstract Optional<String>	serviceAccount()	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).
abstract AuthConfigOidcConfig.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonString, toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AuthConfigOidcConfig

public AuthConfigOidcConfig()

Method Details

idToken

public abstract Optional<String> idToken()

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

serviceAccount

public abstract Optional<String> serviceAccount()

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).

builder

public static AuthConfigOidcConfig.Builder builder()

Instantiates a builder for AuthConfigOidcConfig.

toBuilder

public abstract AuthConfigOidcConfig.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static AuthConfigOidcConfig fromJson(String jsonString)

Deserializes a JSON string to a AuthConfigOidcConfig object.