Cloud AI Platform v1beta1 API - Class AuthConfig.Types.OidcConfig (1.0.0-beta02)

public sealed class AuthConfig.Types.OidcConfig : IMessage<AuthConfig.Types.OidcConfig>, IEquatable<AuthConfig.Types.OidcConfig>, IDeepCloneable<AuthConfig.Types.OidcConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class AuthConfig.Types.OidcConfig.

Config for user OIDC auth.

Inheritance

object > AuthConfig.Types.OidcConfig

Implements

IMessage AuthConfig Types OidcConfig, IEquatable AuthConfig Types OidcConfig, IDeepCloneable AuthConfig Types OidcConfig, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

OidcConfig()

public OidcConfig()

OidcConfig(OidcConfig)

public OidcConfig(AuthConfig.Types.OidcConfig other)

Parameter
Name	Description
`other`	`AuthConfigTypesOidcConfig`

Properties

HasIdToken

public bool HasIdToken { get; }

Gets whether the "id_token" field is set

Property Value
Type	Description
`bool`

HasServiceAccount

public bool HasServiceAccount { get; }

Gets whether the "service_account" field is set

Property Value
Type	Description
`bool`

IdToken

public string IdToken { get; set; }

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

Property Value
Type	Description
`string`

OidcConfigCase

public AuthConfig.Types.OidcConfig.OidcConfigOneofCase OidcConfigCase { get; }

Property Value
Type	Description
`AuthConfigTypesOidcConfigOidcConfigOneofCase`

ServiceAccount

public string ServiceAccount { get; set; }

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

Property Value
Type	Description
`string`