メインコンテンツへスキップ
GET
エンドユーザー取得

承認

Authorization
string
header
必須

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401unauthorized)で失敗します。

パスパラメータ

end_user_id
string<uuid>
必須

照会するエンドユーザーの ID です。

レスポンス

エンドユーザーを正常に取得しました。

id
string<uuid>

エンドユーザー ID。

tenant_id
string<uuid>

テナント ID。

app_id
string<uuid> | null

アプリケーション ID。

type
string

エンドユーザーのタイプ。Service API ユーザーの場合は常に service-api です。

external_user_id
string | null

API リクエストで提供された user 識別子です(例:チャットメッセージを送信user フィールド)。

name
string | null

エンドユーザー名。

is_anonymous
boolean

ユーザーが匿名かどうかを示します。元の API リクエストで user 識別子が提供されなかった場合、true になります。

session_id
string

セッション識別子。デフォルトは external_user_id の値です。

created_at
string<date-time>

作成タイムスタンプ。

updated_at
string<date-time>

最終更新タイムスタンプ。