DOCS Query Roles #110473
Merged
DOCS Query Roles #110473
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
|
Documentation preview: |
albertzaharovits
added
:Security/Security
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-security (Team:Security) |
jfreden
approved these changes
Jul 5, 2024
| [%collapsible%open] | ||
| ==== | ||
| `name`:: | ||
| The <<security-api-put-role-path-params,name>> of the role, which is internally indexed as a keyword. |
There was a problem hiding this comment.
nit (optional): not sure if the ", which is internally indexed as a keyword." is needed. Maybe use the (type) prefix instead, so:
(keyword) The <<security-api-put-role-path-params,name>> of the role
Same comment for all the fields.
There was a problem hiding this comment.
Good point, thanks!
| role. | ||
| role. The returned role format is a simple extension of the <<defining-roles,role definition>> format, | ||
| only adding an extra field `transient_metadata.enabled`. | ||
| This field is `false` in case the role is automatically disabled, for e.g. in case the license |
There was a problem hiding this comment.
Suggested change
| This field is `false` in case the role is automatically disabled, for e.g. in case the license | |
| This field is `false` in case the role is automatically disabled, for example when the license |
Comment on lines
125
to
126
| The following request lists all roles, sorted by the role name. | ||
| This assumes you have the `read_security` <<privileges-list-cluster,privilege>>: |
There was a problem hiding this comment.
Suggested change
| The following request lists all roles, sorted by the role name. | |
| This assumes you have the `read_security` <<privileges-list-cluster,privilege>>: | |
| The following request lists all roles, sorted by the role name: |
| @@ -93,6 +86,12 @@ In addition, sort can also be applied to the `_doc` field to sort by index order | |||
| `search_after`:: | |||
| (Optional, array) <<search-after,Search after>> definition. | |||
|
|
|||
| [[security-api-query-user-query-params]] | |||
There was a problem hiding this comment.
Thanks for the bonus updates!
n1v0lg
reviewed
Jul 5, 2024
| <titleabbrev>Query Role</titleabbrev> | ||
| ++++ | ||
|
|
||
| Retrieves roles with <<query-dsl,Query DSL>> in a <<paginate-search-results,paginated>> fashion. |
There was a problem hiding this comment.
@albertzaharovits For completeness sake wondering if we should mention that you can't query reserved roles, only native ones somewhere.
albertzaharovits
added
auto-merge-without-approval
💚 Backport successful
|
albertzaharovits
added a commit
to albertzaharovits/elasticsearch
that referenced
this pull request
Jul 5, 2024
These are the docs changes in relation to elastic#108733
elasticsearchmachine
pushed a commit
that referenced
this pull request
Jul 5, 2024
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.
These are the docs changes in relation to #108733