› › ›

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

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

Запрос

GET /_security/user

GET /_security/user/<username>

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

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

Описание

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

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

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

Параметры запроса

with_profile_uid: (Необязательно, логическое значение) Определяет, нужно ли получить профиль пользователя uid, если он существует, для пользователей. По умолчанию значение false.

Тело ответа

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

Коды ответов

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

Примеры

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

resp = client.security.get_user(
    username="jacknich",
)
print(resp)

const response = await client.security.getUser({
  username: "jacknich",
});
console.log(response);

GET /_security/user/jacknich

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

Чтобы получить пользователя profile_uid в ответ:

resp = client.security.get_user(
    username="jacknich",
    with_profile_uid=True,
)
print(resp)

const response = await client.security.getUser({
  username: "jacknich",
  with_profile_uid: "true",
});
console.log(response);

GET /_security/user/jacknich?with_profile_uid=true

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

Опустите имя пользователя, чтобы получить всех пользователей:

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

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

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/8.17/security-api-get-user.html