Skip to content

Commit 14884c8

Browse files
authored
Document API-Key APIs require manage_api_key priv (elastic#43869)
Add the "Authorization" section to the API key API docs. These APIs require The new manage_api_key cluster privilege. Relates: elastic#43865 Backport of: elastic#43811
1 parent 6e9ccda commit 14884c8

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

x-pack/docs/en/rest-api/security/create-api-keys.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@ same as the request for create role API. For more details, see
4848
`expiration`::
4949
(string) Optional expiration time for the API key. By default, API keys never expire.
5050

51+
==== Authorization
52+
53+
To use this API, you must have at least the `manage_api_key` cluster privilege.
54+
5155
==== Examples
5256

5357
The following example creates an API key:

x-pack/docs/en/rest-api/security/get-api-keys.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ or `name`.
3939

4040
NOTE: While all parameters are optional, at least one of them is required.
4141

42+
==== Authorization
43+
44+
To use this API, you must have at least the `manage_api_key` cluster privilege.
45+
4246
==== Examples
4347

4448
If you create an API key as follows:

x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ either `id` or `name`.
3939

4040
NOTE: While all parameters are optional, at least one of them is required.
4141

42+
==== Authorization
43+
44+
To use this API, you must have at least the `manage_api_key` cluster privilege.
45+
4246
==== Examples
4347

4448
If you create an API key as follows:

0 commit comments

Comments
 (0)