› › ›

API отключения профиля пользователя

Функция профилей пользователей предназначена только для использования Kibana и решений Elastic по наблюдаемости, корпоративному поиску и Elastic Security. Индивидуальные пользователи и внешние приложения не должны напрямую вызывать этот API. Elastic оставляет за собой право изменять или удалять эту функцию в будущих выпусках без предварительного уведомления.

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

Запрос

POST /_security/profile/<uid>/_disable

PUT /_security/profile/<uid>/_disable

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

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

Описание

При активации профиля пользователя, он автоматически включается и отображается в результатах поиска профилей пользователей. Вы можете использовать API отключения профиля пользователя, чтобы отключить профиль пользователя, чтобы он не отображался в этих результатах поиска.

Для повторного включения отключенного профиля пользователя используйте API включения профиля пользователя.

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

<uid>: (Обязательный, строка) Уникальный идентификатор профиля пользователя.

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

refresh: (Необязательный, перечисление) Если true, Elasticsearch обновляет затронутые фрагменты, чтобы сделать это действие видимым для поиска, если wait_for, то ожидает обновления, чтобы сделать это действие видимым для поиска, если false, то ничего не делает с обновлениями. Допустимые значения: true, false, wait_for. Значение по умолчанию: false.

Примеры

Следующий запрос отключает профиль пользователя для uid, соответствующего u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0:

resp = client.security.disable_user_profile(
    uid="u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0",
)
print(resp)

const response = await client.security.disableUserProfile({
  uid: "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0",
});
console.log(response);

POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable

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