Skip to content

Commit 2523bc0

Browse files
pdabelf5web-flow
authored andcommitted
update APIKey suppliedIn docs (#7084)
1 parent bd708da commit 2523bc0

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

site/content/configuration/policy-resource.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,11 +192,14 @@ data:
192192
{{% table %}}
193193
|Field | Description | Type | Required |
194194
| ---| ---| ---| --- |
195+
|``suppliedIn`` | `header` or `query`. | | Yes |
195196
|``suppliedIn.header`` | An array of headers that the API Key may appear in. | ``string[]`` | No |
196197
|``suppliedIn.query`` | An array of query params that the API Key may appear in. | ``string[]`` | No |
197198
|``clientSecret`` | The name of the Kubernetes secret that stores the API Key(s). It must be in the same namespace as the Policy resource. The secret must be of the type ``nginx.org/apikey``, and the API Key(s) must be stored in a key: val format where each key is a unique clientID and each value is a unique base64 encoded API Key | ``string`` | Yes |
198199
{{% /table %}}
199200

201+
{{<important>}}An APIKey Policy must include a minimum of one of the `suppliedIn.header` or `suppliedIn.query` parameters. Both can also be supplied.{{</important>}}
202+
200203
#### APIKey Merging Behavior
201204

202205
A VirtualServer or VirtualServerRoute can be associated with only one API Key policy per route or subroute. However, it is possible to replace an API Key policy from a higher-level with a different policy defined on a more specific route.

0 commit comments

Comments
 (0)