› › ›

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

Получает роли в собственном домене.

Запрос

GET /_security/role

GET /_security/role/<name>

Предварительные условия

Для использования этого API необходимо иметь, как минимум, право доступа manage_security к кластеру.

Описание

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

Параметры пути

name: (Необязательно, строка) Название роли. Вы можете указать несколько ролей через запятую. Если этот параметр не указан, API возвращает информацию обо всех ролях.

Тело ответа

Успешный вызов возвращает массив ролей с JSON-представлением роли.

Коды ответов

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

Примеры

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

GET /_security/role/my_admin_role

{
  "my_admin_role": {
    "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
    }
  }
}

Для получения всех ролей, опустите имя роли:

GET /_security/role

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/security-api-get-role.html