Skip to content

Commit

Permalink
Document API-Key APIs require manage_api_key priv (#43811)
Browse files Browse the repository at this point in the history
Add the "Authorization" section to the API key API docs.
These APIs require The new manage_api_key cluster privilege.

Relates: #43728
  • Loading branch information
tvernum committed Jul 2, 2019
1 parent c1acc69 commit dbe1e43
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
4 changes: 4 additions & 0 deletions x-pack/docs/en/rest-api/security/create-api-keys.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ same as the request for create role API. For more details, see
`expiration`::
(string) Optional expiration time for the API key. By default, API keys never expire.

==== Authorization

To use this API, you must have at least the `manage_api_key` cluster privilege.

==== Examples

The following example creates an API key:
Expand Down
4 changes: 4 additions & 0 deletions x-pack/docs/en/rest-api/security/get-api-keys.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ or `name`.

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

==== Authorization

To use this API, you must have at least the `manage_api_key` cluster privilege.

==== Examples

If you create an API key as follows:
Expand Down
4 changes: 4 additions & 0 deletions x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ either `id` or `name`.

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

==== Authorization

To use this API, you must have at least the `manage_api_key` cluster privilege.

==== Examples

If you create an API key as follows:
Expand Down

0 comments on commit dbe1e43

Please sign in to comment.