GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig

import type { GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig } from "https://googleapis.deno.dev/v1/dialogflow:v3.ts";

Config for authentication with API key.

interface GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig {

apiKey?: string;

keyName?: string;

requestLocation?: "REQUEST_LOCATION_UNSPECIFIED" | "HEADER" | "QUERY_STRING";

secretVersionForApiKey?: string;

}

§Properties

apiKey?: string

[src]

Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored.

keyName?: string

[src]

Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.

requestLocation?: "REQUEST_LOCATION_UNSPECIFIED" | "HEADER" | "QUERY_STRING"

[src]

Required. Key location in the request.

secretVersionForApiKey?: string

[src]

Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the api_key field will be ignored. Format: projects/{project}/secrets/{secret}/versions/{version}