Skip to content

Commit

Permalink
Invalidate cross cluster API key docs (#108297)
Browse files Browse the repository at this point in the history
This PR documents privilege requirements for cross-cluster API key
invalidation, which were updated in
#107411.
  • Loading branch information
n1v0lg committed May 6, 2024
1 parent c89de11 commit 31afff9
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/reference/rest-api/security/invalidate-api-keys.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ Invalidates one or more API keys.
[[security-api-invalidate-api-key-prereqs]]
==== {api-prereq-title}

* To use this API, you must have at least the `manage_api_key` or the `manage_own_api_key` cluster privilege.
The `manage_api_key` privilege allows deleting any API keys.
The `manage_own_api_key` only allows deleting API keys that are owned by the user.
* To use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privilege.
The `manage_security` privilege allows deleting any API key, including both REST and <<security-api-create-cross-cluster-api-key,cross cluster API keys>>.
The `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys.
The `manage_own_api_key` only allows deleting REST API keys owned by the user.
In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued
in one of the three formats:
1. Set the parameter `owner=true`
Expand Down

0 comments on commit 31afff9

Please sign in to comment.