ユーザーを取得

GET /v1/users/{user_id} · 権限 users:read

1人のユーザーを返します。別の環境のユーザー、存在しないユーザー、削除済みのユーザーはいずれも 404 を返します。環境をまたいで存在が明らかになることはありません。

リクエスト

パラメーター 場所 必須 説明
user_id path はい ユーザーID。プレフィックスは usr_ です。
include query いいえ deleted を指定すると、削除済みユーザーに対して 404 の代わりに削除の記録（トゥームストーン）を取得できます。

include=deleted を指定すると、削除済みユーザーには 410 が返され、deleted_at、deletion_id、backups_purged_by（バックアップからデータが消去される期限日）、統合されたユーザーの場合は merged_into が含まれます。一度も存在しなかったユーザーの場合は、引き続き 404 が返されます。

レスポンス

200 OK。本文はユーザーオブジェクトです。ETag ヘッダーにはユーザーのバージョンが含まれます。

キーに users:read_pii 権限がない場合、個人データはマスクされます。email は a***@e***.com になり、phone_number は末尾2桁のみ残ります（+**********67）。name、given_name、family_name、middle_name、nickname はイニシャルになり（A. L.）、username は先頭1文字のみ残ります（a***）。birthdate は ****-**-** になり、address は {"redacted": true} になります。user_metadata と app_metadata はマスクされません。

{
  "id": "usr_0a1b2c3d4e5f6g7h8j9k0m1n2p",
  "kind": "regular",
  "status": "active",
  "external_id": null,
  "username": null,
  "name": "Ada Lovelace",
  "email": "ada@example.com",
  "email_verified": true,
  "phone_number": null,
  "phone_verified": false,
  "user_metadata": {},
  "app_metadata": {},
  "created_via": "admin_api",
  "created_at": "2026-01-15T09:30:00Z",
  "updated_at": "2026-01-15T09:30:00Z",
  "last_sign_in_at": null,
  "deletion_requested_at": null,
  "deletion_due_at": null
}

エラー

すべてのエラーは、安定した code を含む application/problem+json の本文で返されます。

HTTP code 発生条件
404 not_found この環境にユーザーが存在しない場合（またはIDの形式が不正な場合）。
410 user_deleted ユーザーが削除済みで include=deleted が指定された場合。本文には deleted_at、deletion_id、backups_purged_by、統合されたユーザーの場合は merged_into が含まれます。
401 unauthenticated APIキーが未指定、無効、または取り消し済みの場合。
403 insufficient_permissions キーに users:read 権限がない場合。
429 rate_limited レート制限を超えた場合。Retry-After に従ってください。
503 service_unavailable 依存先が一時的に利用できない場合。後で再試行してください。

例

curl https://api.eu.keenauth.com/v1/users/usr_0a1b2c3d4e5f6g7h8j9k0m1n2p \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

個人データ

このエンドポイントは個人データ（エンドユーザーのプロフィール）を扱います。KeenAuth APIにおける個人データでは、保存される内容、保存期間、削除方法について説明しています。どのフィールドにも、特別な種類の個人データ（健康、生体情報、宗教、政治的意見、性的指向）を送信しないでください。