ユーザーデータのエクスポートジョブを取得する
GET /v1/jobs/user-exports/{job_id} · 権限 users:export
ユーザーデータをエクスポートで作成されたジョブを返します。
status |
意味 |
|---|---|
queued |
実行待ちです。 |
running |
パッケージを作成中です。 |
completed |
パッケージの準備ができています。file にサイズと SHA-256 があります。expires_at より前にダウンロードしてください。 |
failed |
パッケージはありません。failure_reason は too_large、user_deleted、source_unavailable、attempts_exhausted のいずれかです。 |
expired |
完了から7日後にパッケージが削除されました。新しいエクスポートを開始してください。 |
エンドユーザーが自分のアカウントページから要求したエクスポートは、ここには表示されません。
リクエスト
| パラメータ | 指定場所 | 必須 | 説明 |
|---|---|---|---|
job_id |
path | はい | ジョブ ID(job_ で始まる)。 |
レスポンス
200 OK を返します。
{
"id": "job_01j9xk3m7q8r2s4t6v8w0y2z4e",
"kind": "subject",
"source": "management_api",
"user_id": "usr_01j9xk3m7q8r2s4t6v8w0y2z4a",
"status": "completed",
"include_app_metadata": true,
"include_ip": false,
"file": {
"size": 48213,
"sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
},
"failure_reason": null,
"requested_by": { "type": "api_key", "id": "key_01j9xk3m7q8r2s4t6v8w0y2z4b" },
"created_at": "2026-10-28T09:00:00Z",
"started_at": "2026-10-28T09:00:02Z",
"completed_at": "2026-10-28T09:00:09Z",
"expires_at": "2026-11-04T09:00:09Z"
}
エラー
すべてのエラーは、安定した code を持つ application/problem+json ボディで返されます。
| HTTP | code |
発生条件 |
|---|---|---|
| 401 | unauthenticated |
API キーが欠落している、無効である、または取り消されています。 |
| 403 | insufficient_permissions |
キーに users:export 権限がありません。 |
| 404 | not_found |
この環境にジョブが存在しない(または ID の形式が不正)です。 |
| 429 | rate_limited |
レート制限を超えました。Retry-After に従ってください。 |
| 503 | service_unavailable |
依存先が一時的に利用できません。後で再試行してください。 |
例
curl https://api.eu.keenauth.com/v1/jobs/user-exports/job_01j9xk3m7q8r2s4t6v8w0y2z4e \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"
CLI: keenauth jobs user-exports get job_01j9xk3m7q8r2s4t6v8w0y2z4e