Get role mappings

GET /_security/role_mapping/{name}
GET /_security/role_mapping

Role mappings define which roles are assigned to each user. 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.

About mapping users to roles

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_security/role_mapping/mapping1

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_security/role_mapping/mapping1" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().getRoleMapping(g -> g
    .name("mapping1")
);

C# Elasticsearch .NET Client

var response = await client.Security
    .GetRoleMappingAsync(d1 => d1
        .Name(new[] { "mapping1" })
    );

PHP Elasticsearch PHP Client

$resp = $client->security()->getRoleMapping([
    "name" => "mapping1",
]);

Ruby Elasticsearch Ruby Client

response = client.security.get_role_mapping(
  name: "mapping1"
)

Response

A successful response from GET /_security/role_mapping/mapping1.

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