Get role mappings API

GET /_security/role_mapping

GET /_security/role_mapping/<name>

Role mappings define which roles are assigned to each user. For more information, see Mapping users and groups to roles.

The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files.

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.

The following example retrieves information about the mapping1 role mapping:

resp = client.security.get_role_mapping(
    name="mapping1",
)
print(resp)

const response = await client.security.getRoleMapping({
  name: "mapping1",
});
console.log(response);

GET /_security/role_mapping/mapping1

{
  "mapping1": {
    "enabled": true,
    "roles": [
      "user"
    ],
    "rules": {
      "field": {
        "username": "*"
      }
    },
    "metadata": {}
  }
}