Spec-Zone.ru › Elasticsearch 7
›Elasticsearch Guide [7.17] ›REST API ›Security APIs

API получения отображений ролей

Получает отображения ролей.

Запрос

GET /_security/role_mapping

GET /_security/role_mapping/<name>

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

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

Описание

Отображения ролей определяют, какие роли назначены каждому пользователю. Дополнительную информацию см. в разделе Сопоставление пользователей и групп с ролями.

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

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

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

Тело ответа

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

Коды ответа

Если отображение с запрошенным именем отсутствует, ответ будет иметь код состояния 404.

Примеры

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

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

© 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-mapping.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API