エンドユーザー取得

ID を指定してエンドユーザーを取得します。他の API がエンドユーザー ID を返す場合（例：ファイルをアップロードの created_by）に便利です。

GET /end-users/{end_user_id}

Error

A valid request URL is required to generate request examples

200

{
  "id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
  "tenant_id": "11223344-5566-7788-99aa-bbccddeeff00",
  "app_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "type": "service_api",
  "external_user_id": "abc-123",
  "name": null,
  "is_anonymous": false,
  "session_id": "abc-123",
  "created_at": "2024-01-16T12:00:29Z",
  "updated_at": "2024-01-16T12:00:29Z"
}

Authorizations

Authorization · string · header · required

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

Path Parameters

end_user_id · string<uuid> · required

エンドユーザー ID。

Response

200

application/json

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

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>

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