Forward API リファレンス。
Description
Retrieves metadata for a single File by its ID.
パス
GET /api/v1/forward/files/{file_id}
リクエストヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer <PAT または SAT> |
パス参数
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
file_id | string | はい | File ID to retrieve. |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
identity_id | string | No | For Identity-owned resources only. PATs may supply this query parameter; omitting it uses the administrator scope. SAT ownership is determined by the credential; any SAT (including Admin SAT) explicitly supplying this parameter, even with an empty value, receives HTTP 400. See Identity ownership. |
リクエスト例
レスポンス例
HTTP 200 OK
レスポンスフィールド
The response is a File object.
エラー
| HTTP | Type | 発生条件 |
|---|---|---|
| 400 | invalid_request_error | リクエストボディ、パスパラメーター、またはクエリパラメーターが不正です。SAT でクエリパラメーター identity_id を明示的に指定した場合（空値を含む）も該当します。 |
| 401 | authentication_error | 認証トークンがないか、無効です。 |
| 403 | permission_error | 管理者 Scope で Owner mismatch が発生したか、下流サービスがアクセスを拒否しました。 |
| 404 | not_found_error | File が存在しないか、現在の Identity Scope から参照できません。PAT で指定した Identity が無効、無効化済み、削除済み、または権限範囲外の場合も該当します。 |
| 500/502/503 | api_error | Forward または依存サービスでエラーが発生しました。 |