Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class ApiKeyConfig (2.0.0)

ApiKeyConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Config for authentication with API key.

Attributes
Name	Description
`key_name`	`str` 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=
`api_key`	`str` Optional. The API key. If the `secret_version_for_api_key` field is set, this field will be ignored.
`secret_version_for_api_key`	`str` 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}`
`request_location`	`google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.RequestLocation` Required. Key location in the request.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-14 UTC.

Attributes