Browse Source

Update role-mapping-resources.asciidoc (#110441)

made it clear that some characters need to be escaped properly

Co-authored-by: Jan Doberstein <jan.doberstein@elastic.co>
George Wallace 1 year ago
parent
commit
b6e9860919
1 changed files with 1 additions and 1 deletions
  1. 1 1
      docs/reference/rest-api/security/role-mapping-resources.asciidoc

+ 1 - 1
docs/reference/rest-api/security/role-mapping-resources.asciidoc

@@ -70,7 +70,7 @@ 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. For example, `"metadata": { "cn": "John Smith" }`.
+(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" }`.
 `realm`::  
 (object) The realm that authenticated the user. The only field in this object is the realm name. For example, `"realm": { "name": "ldap1" }`.