From 7e32e71763c085c0148dfd5c0491ed8ae0565413 Mon Sep 17 00:00:00 2001 From: Tim Vernum Date: Mon, 1 Jul 2019 21:02:26 +1000 Subject: [PATCH] Document API-Key APIs require manage_api_key priv Add the "Authorization" section to the API key API docs. These APIs require The new manage_api_key cluster privilege. Relates: #43728 --- x-pack/docs/en/rest-api/security/create-api-keys.asciidoc | 4 ++++ x-pack/docs/en/rest-api/security/get-api-keys.asciidoc | 4 ++++ x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc | 4 ++++ 3 files changed, 12 insertions(+) diff --git a/x-pack/docs/en/rest-api/security/create-api-keys.asciidoc b/x-pack/docs/en/rest-api/security/create-api-keys.asciidoc index a9cab0f8d545c..5fda7c5c3e488 100644 --- a/x-pack/docs/en/rest-api/security/create-api-keys.asciidoc +++ b/x-pack/docs/en/rest-api/security/create-api-keys.asciidoc @@ -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: diff --git a/x-pack/docs/en/rest-api/security/get-api-keys.asciidoc b/x-pack/docs/en/rest-api/security/get-api-keys.asciidoc index 0e5865c3cd9ae..4d7084e1ece26 100644 --- a/x-pack/docs/en/rest-api/security/get-api-keys.asciidoc +++ b/x-pack/docs/en/rest-api/security/get-api-keys.asciidoc @@ -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: diff --git a/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc b/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc index 595fb2db2a677..5e6351683b752 100644 --- a/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc +++ b/x-pack/docs/en/rest-api/security/invalidate-api-keys.asciidoc @@ -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: