GoogleCloudAiplatformV1AuthConfigApiKeyConfig
import type { GoogleCloudAiplatformV1AuthConfigApiKeyConfig } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";Config for authentication with API key.
interface GoogleCloudAiplatformV1AuthConfigApiKeyConfig {
apiKeySecret?: string;
apiKeyString?: string;
httpElementLocation?:
| "HTTP_IN_UNSPECIFIED"
| "HTTP_IN_QUERY"
| "HTTP_IN_HEADER"
| "HTTP_IN_PATH"
| "HTTP_IN_BODY"
| "HTTP_IN_COOKIE";
name?: string;
}§Properties
§
apiKeySecret?: string
[src]Optional. The name of the SecretManager secret version resource storing
the API key. Format:
projects/{project}/secrets/{secrete}/versions/{version} - If both
api_key_secret and api_key_string are specified, this field takes
precedence over api_key_string. - If specified, the
secretmanager.versions.access permission should be granted to Vertex AI
Extension Service Agent
(https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
on the specified resource.
§
httpElementLocation?: "HTTP_IN_UNSPECIFIED" | "HTTP_IN_QUERY" | "HTTP_IN_HEADER" | "HTTP_IN_PATH" | "HTTP_IN_BODY" | "HTTP_IN_COOKIE"
[src]Optional. The location of the API key.
§
name?: string
[src]Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.