› › ›

API получения пользователей

Получает информацию о пользователях в собственном домене и встроенных пользователях.

Запрос

GET /_security/user

GET /_security/user/<username>

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

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

Описание

Дополнительную информацию о собственном домене см. в разделах Домены и Аутентификация пользователей в собственном домене.

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

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

Тело ответа

Успешный вызов возвращает массив пользователей с JSON-представлением пользователей. Обратите внимание, что пароли пользователей не включаются.

Коды ответа

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

Примеры

Чтобы получить информацию о пользователе в собственном домене, отправьте GET-запрос к концу /_security/user/<username>:

GET /_security/user/jacknich

{
  "jacknich": {
    "username": "jacknich",
    "roles": [
      "admin", "other_role1"
    ],
    "full_name": "Jack Nicholson",
    "email": "jacknich@example.com",
    "metadata": { "intelligence" : 7 },
    "enabled": true
  }
}

Чтобы получить информацию обо всех пользователях, опустите имя пользователя:

GET /_security/user

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