Skip to content

[DOCS] Clarify retrieving own API keys with 'manage_own_api_key' privilege #98065

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 1, 2023
Merged

[DOCS] Clarify retrieving own API keys with 'manage_own_api_key' privilege #98065

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9581c7d
[DOCS] Clarify retrieving own API keys with 'manage_own_api_key' priv…
abdonpijpelink Jul 31, 2023
a120b4d
Review feedback
abdonpijpelink Aug 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions x-pack/docs/en/rest-api/security/get-api-keys.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,15 @@ Retrieves information for one or more API keys.
[[security-api-get-api-key-prereqs]]
==== {api-prereq-title}

* To use this API, you must have at least the `manage_own_api_key` or the `read_security`
cluster privileges.
* If you have only the `manage_own_api_key` privilege, this API returns only
the API keys that you own. If you have `read_security`, `manage_api_key` or greater
* To use this API, you must have at least the `manage_own_api_key` or the
`read_security` cluster privileges.
** If you only have the `manage_own_api_key` privilege, this API only returns
the API keys that you own.
+
NOTE: Authenticating with an API key that has the `manage_own_api_key` privilege
does not allow retrieving the authenticated user's own keys. Instead,
authenticate the user with basic credentials.
** If you have `read_security`, `manage_api_key` or greater
privileges (including `manage_security`), this API returns all API keys
regardless of ownership.

Expand Down