IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get role mappings APIedit
Retrieves role mappings.
Descriptionedit
Role mappings define which roles are assigned to each user. For more information, see Mapping users and groups to roles.
Path Parametersedit
-
name
- (string) The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. You can specify multiple mapping names as a comma-separated list. If you do not specify this parameter, the API returns information about all role mappings.
Resultsedit
A successful call retrieves an object, where the keys are the names of the request mappings, and the values are the JSON representation of those mappings. For more information, see Role mapping resources.
If there is no mapping with the requested name, the
response will have status code 404
.
Authorizationedit
To use this API, you must have at least the manage_security
cluster privilege.
Examplesedit
The following example retrieves information about the mapping1
role mapping:
GET /_xpack/security/role_mapping/mapping1
{ "mapping1": { "enabled": true, "roles": [ "user" ], "rules": { "field": { "username": "*" } }, "metadata": {} } }