Skip to content

Enhance docs for create api keys created when role descriptor not specified #46897

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
Sep 26, 2019
Merged

Enhance docs for create api keys created when role descriptor not specified #46897

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33264ca
Enhance docs for create api keys created when role descriptor not spe…
Sep 20, 2019
db121a1
correct the sentence
Sep 25, 2019
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
11 changes: 6 additions & 5 deletions x-pack/docs/en/rest-api/security/create-api-keys.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,12 @@ The following parameters can be specified in the body of a POST or PUT request:
`role_descriptors`::
(Optional, array-of-role-descriptor) An array of role descriptors for this API
key. This parameter is optional. When it is not specified or is an empty array,
then the API key will have the permissions of the authenticated user. If you
supply role descriptors, they must be a subset of the authenticated user's
permissions. The structure of role descriptor is the same as the request for
create role API. For more details, see
<<security-api-roles,role management APIs>>.
then the API key will have a _point in time snapshot of permissions of the
authenticated user_. If you supply role descriptors then the resultant permissions
would be an intersection of API keys permissions and authenticated user's permissions
thereby limiting the access scope for API keys.
The structure of role descriptor is the same as the request for create role API.
For more details, see <<security-api-roles,role management APIs>>.

`expiration`::
(Optional, string) Expiration time for the API key. By default, API keys never
Expand Down