Interface AuthConfig

The authentication config to access the API.

interface AuthConfig {
    apiKey?: string;
    apiKeyConfig?: ApiKeyConfig;
    authType?: AuthType;
    googleServiceAccountConfig?: AuthConfigGoogleServiceAccountConfig;
    httpBasicAuthConfig?: AuthConfigHttpBasicAuthConfig;
    oauthConfig?: AuthConfigOauthConfig;
    oidcConfig?: AuthConfigOidcConfig;
}

Index

Properties

apiKey? apiKeyConfig? authType? googleServiceAccountConfig? httpBasicAuthConfig? oauthConfig? oidcConfig?

Properties

`Optional`apiKey

apiKey?: string

The authentication config to access the API. Only API key is supported. This field is not supported in Gemini API.

`Optional`apiKeyConfig

apiKeyConfig?: ApiKeyConfig

Config for API key auth.

`Optional`authType

authType?: AuthType

Type of auth scheme.

`Optional`googleServiceAccountConfig

googleServiceAccountConfig?: AuthConfigGoogleServiceAccountConfig

Config for Google Service Account auth.

`Optional`httpBasicAuthConfig

httpBasicAuthConfig?: AuthConfigHttpBasicAuthConfig

Config for HTTP Basic auth.

`Optional`oauthConfig

oauthConfig?: AuthConfigOauthConfig

Config for user oauth.

`Optional`oidcConfig

oidcConfig?: AuthConfigOidcConfig

Config for user OIDC auth.