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

ユーザープロファイルAPIの無効化

ユーザープロファイル機能は、KibanaおよびElasticのObservability、Enterprise Search、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。

例

次のリクエストは、u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0に一致するuidのユーザープロファイルを無効にします:

Python

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

Js

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

コンソール

POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable