Class AuthConfigOidcConfig

Namespace

Google.GenAI.Types

Assembly

Google.GenAI.dll

Config for user OIDC auth. This data type is not supported in Gemini API.

public record AuthConfigOidcConfig : IEquatable<AuthConfigOidcConfig>

Inheritance

object

AuthConfigOidcConfig

Implements

IEquatable<AuthConfigOidcConfig>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

IdToken

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

[JsonPropertyName("idToken")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? IdToken { get; set; }

Property Value

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

[JsonPropertyName("serviceAccount")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? ServiceAccount { get; set; }

Property Value

string

Methods

FromJson(string, JsonSerializerOptions?)

Deserializes a JSON string to a AuthConfigOidcConfig object.

public static AuthConfigOidcConfig? FromJson(string jsonString, JsonSerializerOptions? options = null)

Parameters

jsonString string

The JSON string to deserialize.

options JsonSerializerOptions

Optional JsonSerializerOptions.

Returns

AuthConfigOidcConfig

The deserialized AuthConfigOidcConfig object, or null if deserialization fails.