Skip to content

Commit 38b847a

Browse files
authored
Enhance docs for create api keys created when role descriptor not specified (#46897)
This commit adds the documentation to point the user that when one creates API keys with no role descriptor specified then that API key will have a point in time snapshot of user permissions. Closes#46876
1 parent b1a03a1 commit 38b847a

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

x-pack/docs/en/rest-api/security/create-api-keys.asciidoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,12 @@ The following parameters can be specified in the body of a POST or PUT request:
4949
`role_descriptors`::
5050
(Optional, array-of-role-descriptor) An array of role descriptors for this API
5151
key. This parameter is optional. When it is not specified or is an empty array,
52-
then the API key will have the permissions of the authenticated user. If you
53-
supply role descriptors, they must be a subset of the authenticated user's
54-
permissions. The structure of role descriptor is the same as the request for
55-
create role API. For more details, see
56-
<<security-api-roles,role management APIs>>.
52+
then the API key will have a _point in time snapshot of permissions of the
53+
authenticated user_. If you supply role descriptors then the resultant permissions
54+
would be an intersection of API keys permissions and authenticated user's permissions
55+
thereby limiting the access scope for API keys.
56+
The structure of role descriptor is the same as the request for create role API.
57+
For more details, see <<security-api-roles,role management APIs>>.
5758

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

0 commit comments

Comments
 (0)