Add warning about derived API keys to docs #62351
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This updates the Create API Key reference document with information about the limitations of derived API keys. Since ES v7.6.0, API keys that are created from an API key (what we refer to as "derived API keys" must be created with an empty privileges list (to explicitly match the effective behaviour of all earlier versions). This information was included in the release notes, but didn't get added to the API reference. Relates: elastic#53647, elastic#54522, elastic#60154
tvernum
added
>docs
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-security (:Security/Authentication) |
elasticmachine
added
Team:Docs
lcawl
reviewed
Sep 15, 2020
ywangd
approved these changes
Sep 16, 2020
| possible to create an API key that is a child of another API key, unless the derived | ||
| key is created without any privileges. In this case, you must explicitly specify a | ||
| role descriptor with no privileges, and the derived API key can be used for | ||
| authentication only, but will not have access to call {es} APIs. |
There was a problem hiding this comment.
Technically, it is not "only" the authentication, but a few actions that requires "the same user", e.g. it can also call GET _security/api_key?owner=true. Without complicating things too much by explaining all the details, maybe we could just drop the only bit.
Co-authored-by: Lisa Cawley <[email protected]>
|
@elasticmachine update branch |
lcawl
pushed a commit
that referenced
this pull request
Sep 17, 2020
lcawl
pushed a commit
that referenced
this pull request
Sep 17, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates the Create API Key reference document with
information about the limitations of derived API keys.
Since ES v7.6.0 (and v6.8.8), API keys that are created from an
API key (what we refer to as "derived API keys") must be created
with an empty privileges list (to explicitly match the effective
behaviour of all earlier versions).
This information was included in the release notes, but didn't get
added to the API reference.
Doc Preview: https://elasticsearch_62351.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/security-api-create-api-key.html
Relates: #53647, #54522, #60154