セキュリティユーザープロセッサの設定

現在認証されたユーザーから現在のドキュメントにユーザー関連の詳細（username、roles、email、full_name、metadata、api_key、realm、authentication_type）を、インジェストの前処理によって設定します。api_keyプロパティは、ユーザーがAPIキーで認証された場合にのみ存在します。これは、APIキーのid、name、metadata（存在し、空でない場合）のフィールドを含むオブジェクトです。realmプロパティもnameとtypeの2つのフィールドを持つオブジェクトです。APIキー認証を使用する場合、realmプロパティはAPIキーが作成されたレルムを指します。authentication_typeプロパティは、REALM、API_KEY、TOKEN、ANONYMOUSから値を取ることができる文字列です。

インデックスリクエストには認証されたユーザーが必要です。


表41. セキュリティユーザーオプションの設定

名前 必須 デフォルト 説明
field はい - ユーザー情報を格納するフィールド。
properties いいえ [username、roles、email、full_name、metadata、api_key、realm、authentication_type] fieldに追加されるユーザー関連プロパティを制御します。
description いいえ - プロセッサの説明。プロセッサの目的や構成を説明するのに役立ちます。
if いいえ - プロセッサを条件付きで実行します。プロセッサを条件付きで実行するを参照してください。
ignore_failure いいえ false プロセッサの失敗を無視します。パイプラインの失敗を処理するを参照してください。
on_failure いいえ - プロセッサの失敗を処理します。パイプラインの失敗を処理するを参照してください。
tag いいえ - プロセッサの識別子。デバッグやメトリクスに役立ちます。

次の例は、現在認証されたユーザーのすべてのユーザー詳細を、このパイプラインによって処理されるすべてのドキュメントのuserフィールドに追加します:

Js

  1. {
  2.   "processors" : [
  3.    {
  4.    "set_security_user": {
  5.    "field": "user"
  6.    }
  7.    }
  8.   ]
  9. }