エクスポートをダウンロード
GET /fapi/v1/me/exports/{export_id}/download · 環境のサインインホストから呼び出します
サインイン中のユーザーが完了させたエクスポートの 1 つについて、ZIP パッケージを添付ファイルとして返します(Content-Type: application/zip、Content-Disposition: attachment; filename="user-export-job_….zip")。ファイルを確認するには、エクスポートの file.sha256 と比較してください。各ダウンロードは、最初のバイトを送信する前に環境の監査ログに記録されます。転送が途中で切れた場合は接続が閉じられるため、不完全なファイルが完全なものに見えることはありません。その場合は再度ダウンロードしてください。
リクエストと同様に、直近のサインインが必要です。セッションが直近 5 分以内に検証されていない場合、またはユーザーに第 2 要素があるのにセッションがそれを使用していない場合は、401 step_up_required を返します。HEAD はサポートされていません(405)。
リクエスト
ヘッダー:
| ヘッダー | 必須 | 説明 |
|---|---|---|
Idp-Client |
はい | SDK の識別子。 |
レスポンス
200 OK。ボディとして ZIP ファイルを返します。
エラー
| ステータス | コード | 発生条件 |
|---|---|---|
| 401 | unauthenticated |
有効なセッション Cookie がありません。 |
| 401 | step_up_required |
サインインから 5 分以上経過しているか、第 2 要素が必要です。WWW-Authenticate ヘッダーには max_age=300(第 2 要素が必要な場合は acr_values も)が含まれます。 |
| 404 | not_found |
そのユーザーのエクスポートは存在しません。 |
| 409 | conflict |
エクスポートがまだ完了していないか、ファイルの有効期限が切れています。 |
| 503 | service_unavailable |
ユーザーディレクトリが一時的に利用できません。Retry-After の後に再試行してください。 |
例
curl -OJ https://example.keenauth.app/fapi/v1/me/exports/job_01jbx4k6v8m2c9w5s7r3t1q0zy/download \
-H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
-b cookies.txt
個人データ
このエンドポイントは個人データを扱います: エンドユーザーのプロフィール、認証情報、連携 ID、セッション、組織メンバーシップと招待、同意の記録、環境ログ、プライバシーリクエスト(パッケージには、これらeach種類のユーザー自身のデータが含まれます)。KeenAuth API における個人データ で、保存される内容、保存期間、削除方法を説明しています。いかなるフィールドにも、特別カテゴリの個人データ(健康、生体データ、宗教、政治的意見、性的指向)を送信しないでください。