Class GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2

OAuth2 configuration.

Inheritance
object
GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2 : IDirectResponseSchema

Properties

AuthorizationUri

Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent The redirect_uri parameter will be overwritten by the Vertex AI Search frontend.

Declaration
[JsonProperty("authorizationUri")]
public virtual string AuthorizationUri { get; set; }
Property Value
Type Description
string

BasicAuthenticationEnabled

Optional. Whether the OAuth token exchange uses HTTP Basic authentication (client_secret_basic) instead of sending the client credentials in the request body (client_secret_post). When true, the credentials (client_id:client_secret) are Base64 encoded and sent in the Authorization header. Some OAuth providers (e.g. Splunk) require client_secret_basic. When false or unset, the default client_secret_post is used.

Declaration
[JsonProperty("basicAuthenticationEnabled")]
public virtual bool? BasicAuthenticationEnabled { get; set; }
Property Value
Type Description
bool?

ClientId

Required. The OAuth2 client ID.

Declaration
[JsonProperty("clientId")]
public virtual string ClientId { get; set; }
Property Value
Type Description
string

ClientSecret

Required. The OAuth2 client secret. Encrypted at rest.

Declaration
[JsonProperty("clientSecret")]
public virtual string ClientSecret { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

PkceVerificationEnabled

Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/

Declaration
[JsonProperty("pkceVerificationEnabled")]
public virtual bool? PkceVerificationEnabled { get; set; }
Property Value
Type Description
bool?

PrivateNetworkConfig

Optional. Set only when the OAuth provider publishes no public endpoint, in which case a token exchange has to be routed over the private network the instance is on instead of over public egress. Leaving it unset keeps the exchange on public egress.

Declaration
[JsonProperty("privateNetworkConfig")]
public virtual GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2PrivateNetworkConfig PrivateNetworkConfig { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2PrivateNetworkConfig

Scopes

Optional. The scopes to request. Example: https://www.googleapis.com/auth/calendar.events If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization.

Declaration
[JsonProperty("scopes")]
public virtual IList<string> Scopes { get; set; }
Property Value
Type Description
IList<string>

TokenUri

Required. The HTTP endpoint that exchanges a client authorization for an access token.

Declaration
[JsonProperty("tokenUri")]
public virtual string TokenUri { get; set; }
Property Value
Type Description
string

Implements