Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Руководство [8.17] ›REST API ›API безопасности

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

Новая справка по API

Для получения самых актуальных данных об API обратитесь к API безопасности.

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

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

Запрос

POST /_security/profile/<uid>/_enable

PUT /_security/profile/<uid>/_enable

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

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

Описание

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

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

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

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

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

Примеры

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

resp = client.security.enable_user_profile(
    uid="u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0",
)
print(resp)
const response = await client.security.enableUserProfile({
  uid: "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0",
});
console.log(response);
POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_enable

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

Spec-Zone.ru

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