ユーザープロファイルの有効化（Enable user profile）

ユーザープロファイル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のユーザープロファイルを有効にします:

Python

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

Js

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

コンソール

POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_enable