Update role-mapping-resources.asciidoc #110451
Open
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
used the suggestions from #110420 (comment) to be even more clear.
|
Documentation preview: |
|
@jalogisch please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation. |
elasticsearchmachine
added
external-contributor
|
Pinging @elastic/es-docs (Team:Docs) |
shainaraskas
approved these changes
Jul 4, 2024
| @@ -70,7 +70,11 @@ example, `"username": "jsmith"`. | |||
| `groups`:: | |||
| (array of strings) The groups to which the user belongs. For example, `"groups" : [ "cn=admin,ou=groups,dc=example,dc=com","cn=esusers,ou=groups,dc=example,dc=com ]`. | |||
| `metadata`:: | |||
| (object) Additional metadata for the user. This can include a variety of key-value pairs. When referencing metadata fields in role mapping rules, use the dot notation to specify the key within the metadata object. If the key contains special characters such as parentheses, dots, or spaces, you must escape these characters using backslashes (`\`). For example, `"metadata": { "cn": "John Smith" }`. | |||
|
|
|||
| (object) Additional metadata for the user is passed as key-value pairs. For example, `"metadata": { "cn": "John Smith" }`. | |||
There was a problem hiding this comment.
this structure makes it clearer that "passed as kv pairs" clarifies "additional metadata"
Suggested change
| (object) Additional metadata for the user is passed as key-value pairs. For example, `"metadata": { "cn": "John Smith" }`. | |
| (object) Additional metadata for the user, passed as key-value pairs. For example, `"metadata": { "cn": "John Smith" }`. |
Comment on lines
+75
to
+76
|
|
||
| When referencing metadata fields in role mapping rules, use dot notation to specify the key within the metadata object. If the key contains special characters such as parentheses, dots, or spaces, you must escape these characters using backslashes (`\`). |
There was a problem hiding this comment.
I think we can add a + to get this formatted so it's indented (it's clearer the content is all related if it's indented)
Suggested change
| When referencing metadata fields in role mapping rules, use dot notation to specify the key within the metadata object. If the key contains special characters such as parentheses, dots, or spaces, you must escape these characters using backslashes (`\`). | |
| + | |
| When referencing metadata fields in role mapping rules, use dot notation to specify the key within the metadata object. If the key contains special characters such as parentheses, dots, or spaces, you must escape these characters using backslashes (`\`). |
this is how it currently looks
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.
I used the suggestions from #110420 (comment) to make it even clearer.