Class ApiKeyConfig (1.42.0)
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
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-09-09 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Class ApiKeyConfig (1.42.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.42.0 (latest)](/python/docs/reference/dialogflow-cx/latest/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.41.1](/python/docs/reference/dialogflow-cx/1.41.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.40.0](/python/docs/reference/dialogflow-cx/1.40.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.39.0](/python/docs/reference/dialogflow-cx/1.39.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.38.0](/python/docs/reference/dialogflow-cx/1.38.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.37.0](/python/docs/reference/dialogflow-cx/1.37.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.36.0](/python/docs/reference/dialogflow-cx/1.36.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.35.0](/python/docs/reference/dialogflow-cx/1.35.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.34.1](/python/docs/reference/dialogflow-cx/1.34.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.33.0](/python/docs/reference/dialogflow-cx/1.33.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.32.1](/python/docs/reference/dialogflow-cx/1.32.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.31.1](/python/docs/reference/dialogflow-cx/1.31.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.30.1](/python/docs/reference/dialogflow-cx/1.30.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.29.0](/python/docs/reference/dialogflow-cx/1.29.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.28.0](/python/docs/reference/dialogflow-cx/1.28.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.27.0](/python/docs/reference/dialogflow-cx/1.27.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.26.0](/python/docs/reference/dialogflow-cx/1.26.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.25.0](/python/docs/reference/dialogflow-cx/1.25.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.24.0](/python/docs/reference/dialogflow-cx/1.24.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.23.1](/python/docs/reference/dialogflow-cx/1.23.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.22.0](/python/docs/reference/dialogflow-cx/1.22.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.21.0](/python/docs/reference/dialogflow-cx/1.21.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.20.1](/python/docs/reference/dialogflow-cx/1.20.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.19.0](/python/docs/reference/dialogflow-cx/1.19.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.18.0](/python/docs/reference/dialogflow-cx/1.18.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.17.1](/python/docs/reference/dialogflow-cx/1.17.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.16.0](/python/docs/reference/dialogflow-cx/1.16.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.15.0](/python/docs/reference/dialogflow-cx/1.15.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.14.1](/python/docs/reference/dialogflow-cx/1.14.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.13.5](/python/docs/reference/dialogflow-cx/1.13.5/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.12.1](/python/docs/reference/dialogflow-cx/1.12.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.11.0](/python/docs/reference/dialogflow-cx/1.11.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.10.0](/python/docs/reference/dialogflow-cx/1.10.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.9.1](/python/docs/reference/dialogflow-cx/1.9.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.8.0](/python/docs/reference/dialogflow-cx/1.8.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.7.0](/python/docs/reference/dialogflow-cx/1.7.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.6.0](/python/docs/reference/dialogflow-cx/1.6.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.5.0](/python/docs/reference/dialogflow-cx/1.5.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.4.0](/python/docs/reference/dialogflow-cx/1.4.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.3.2](/python/docs/reference/dialogflow-cx/1.3.2/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.2.0](/python/docs/reference/dialogflow-cx/1.2.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.1.1](/python/docs/reference/dialogflow-cx/1.1.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [1.0.0](/python/docs/reference/dialogflow-cx/1.0.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [0.8.2](/python/docs/reference/dialogflow-cx/0.8.2/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [0.7.1](/python/docs/reference/dialogflow-cx/0.7.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [0.6.0](/python/docs/reference/dialogflow-cx/0.6.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [0.5.0](/python/docs/reference/dialogflow-cx/0.5.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [0.4.1](/python/docs/reference/dialogflow-cx/0.4.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [0.3.0](/python/docs/reference/dialogflow-cx/0.3.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [0.2.0](/python/docs/reference/dialogflow-cx/0.2.0/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig)\n- [0.1.1](/python/docs/reference/dialogflow-cx/0.1.1/google.cloud.dialogflowcx_v3beta1.types.Tool.Authentication.ApiKeyConfig) \n\n ApiKeyConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nConfig for authentication with API key."]]
