一括ユーザー削除の結果を一覧表示する

GET /v1/jobs/user-deletions/{job_id}/results · 権限 users:delete

一括ユーザー削除ジョブ内の各ユーザーの結果を、リクエストの順序で一覧表示します（position は1から始まります）。各結果は次のいずれかです。

pending: ユーザーの結果がまだありません。
succeeded: ユーザーの削除が開始されました。deletion_id は、そのユーザーに対して DELETE /v1/users/{user_id} が返すものと同じIDです。
not_found: ユーザーがこの環境に存在しないか、すでに削除されています。
failed: 数回の試行の後に削除が失敗しました。error_code は internal です。そのユーザーを個別に、または新しいジョブで再度削除してください。

結果にはユーザーIDのみが含まれ、他の個人データは返されません。一覧は前方へのみページ送りできます。次のページには list_metadata.after を使用してください。before と order はサポートされていません。

リクエスト

パラメータ	入力	必須	説明
`job_id`	path	はい	ジョブID。`job_` で始まります。
`limit`	query	いいえ	ページサイズ。1〜100。既定値は20。
`after`	query	いいえ	`list_metadata.after` から得た不透明なカーソル。同じジョブに対してのみ有効です。

レスポンス

200 OK。list_metadata.after は次のページのカーソルです（最後のページでは null）。list_metadata.before は常に null です。

{
  "data": [
    {
      "position": 1,
      "user_id": "usr_01h455vb4pex5vsknk084sn02q",
      "status": "succeeded",
      "deletion_id": "0191f0a0-0000-8000-8000-000000000001"
    },
    {
      "position": 2,
      "user_id": "usr_01h455vb4pex5vsknk084sn02r",
      "status": "not_found"
    }
  ],
  "list_metadata": { "before": null, "after": null }
}

エラー

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

HTTP	`code`	情況
400	`invalid_cursor`	カーソルの形式が不正、期限切れ、または別のジョブに属しています。
401	`unauthenticated`	APIキーがないか、無効または失効しています。
403	`insufficient_permissions`	キーに `users:delete` 権限がありません。
404	`not_found`	この環境にジョブがありません（またはIDの形式が不正です）。
422	`validation_failed`	`limit` が範囲外か、`before` または `order` が送信されました（`not_supported`）。
429	`rate_limited`	レート制限を超えました。`Retry-After` に従ってください。
503	`service_unavailable`	依存サービスが一時的に利用できません。後で再試行してください。

例

curl "https://api.eu.keenauth.com/v1/jobs/user-deletions/job_01h455vb4pex5vsknk084sn02q/results?limit=100" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

CLI: keenauth jobs user-deletions results job_01h455vb4pex5vsknk084sn02q --limit 100