Forward API リファレンス。
Description
Lists Files visible to the current account, with pagination and filtering.
パス
GET /api/v1/forward/files
リクエストヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer <PAT または SAT> |
クエリパラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
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. |
limit | integer | いいえ | ページサイズです。最大 100。 |
page | string | No | Pagination cursor (recommended), taken from next_page in the previous response. Mutually exclusive with after_id and before_id. |
after_id | string | No | Forward pagination cursor. Mutually exclusive with page and before_id. |
before_id | string | No | Backward pagination cursor. Mutually exclusive with page and after_id. |
name | string | いいえ | ファイル名で検索します。 |
scope_id | string | いいえ | リソーススコープ ID で絞り込みます。主に Session のリソースファイルで使用します。before_id または after_id と併用しないでください。このフィルターモードではカーソルは無視されます。 |
リクエスト例
レスポンス例
空のリストレスポンス
レスポンスフィールド
Each item in the response data array is a File object. See List pagination fields for pagination fields.
エラー
| HTTP | Type | 発生条件 |
|---|---|---|
| 400 | invalid_request_error | リクエストボディ、パスパラメーター、またはクエリパラメーターが不正です。SAT でクエリパラメーター identity_id を明示的に指定した場合(空値を含む)も該当します。 |
| 401 | authentication_error | 認証トークンがないか、無効です。 |
| 403 | permission_error | 管理者 Scope で Owner mismatch が発生したか、下流サービスがアクセスを拒否しました。 |
| 404 | not_found_error | PAT で指定した Identity が存在しない、無効化または削除されている、あるいは呼び出し元に属していません。 |
| 500/502/503 | api_error | Forward または依存サービスでエラーが発生しました。 |

