API получения ролей

GET /_security/role

GET /_security/role/<name>

В целом, для управления ролями предпочтительнее использовать API управления ролями, а не управление ролями через файлы. API получения ролей не может получить роли, определённые в файлах ролей.

Успешный вызов возвращает массив ролей с JSON-представлением роли. Формат возвращаемой роли — простое расширение формата определения роли, в котором добавлено дополнительное поле transient_metadata.enabled. Это поле равно false, если роль автоматически отключена, например, когда уровень лицензии не допускает некоторых разрешений, предоставленных этой ролью.

Если роль не определена в родном домене, запрос возвращает 404.

Следующий пример получает информацию о роли my_admin_role в родном домене:

resp = client.security.get_role(
    name="my_admin_role",
)
print(resp)

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

GET /_security/role/my_admin_role

{
  "my_admin_role": {
    "description": "Grants full access to all management features within the cluster.",
    "cluster" : [ "all" ],
    "indices" : [
      {
        "names" : [ "index1", "index2" ],
        "privileges" : [ "all" ],
        "allow_restricted_indices" : false,
        "field_security" : {
          "grant" : [ "title", "body" ]}
      }
    ],
    "applications" : [ ],
    "run_as" : [ "other_user" ],
    "metadata" : {
      "version" : 1
    },
    "transient_metadata": {
      "enabled": true
    }
  }
}

Чтобы получить все роли, опустите имя роли:

resp = client.security.get_role()
print(resp)

const response = await client.security.getRole();
console.log(response);

GET /_security/role