API получения отображений ролей
Получает отображения ролей.
Запрос
GET /_security/role_mapping
GET /_security/role_mapping/<name>
Предварительные условия
- Для использования этого API необходимо обладать по крайней мере правом
read_securityна кластер.
Описание
Отображения ролей определяют, какие роли назначены каждому пользователю. Дополнительную информацию см. в разделе Сопоставление пользователей и групп с ролями.
API отображения ролей, как правило, предпочтительнее для управления отображениями ролей, чем использование файлов сопоставления ролей. API получения отображений ролей не может получить отображения ролей, определённые в файлах сопоставления ролей.
Параметры пути
-
name - (Необязательно, строка) Уникальное имя, идентифицирующее отображение роли. Это имя используется только как идентификатор для облегчения взаимодействия через API; оно никак не влияет на поведение отображения. Вы можете указать несколько имён отображений через запятую. Если вы не укажете этот параметр, API вернёт информацию обо всех отображениях ролей.
Тело ответа
Успешный вызов возвращает объект, где ключи — имена запрошенных отображений, а значения — JSON-представление этих отображений. Дополнительную информацию см. в разделе Ресурсы отображения ролей.
Коды ответов
Если отображение с запрошенным именем отсутствует, ответ будет иметь код состояния 404.
Примеры
Следующий пример получает информацию об отображении роли mapping1:
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": {}
}
}
© 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/8.17/security-api-get-role-mapping.html