Vault の検索

POST /api/v1/forward/vaults/search Supports PAT, Admin SAT, and Identity SAT. You must include x-qoder-beta: search-2026-08-31. Search filters are optional and belong in the JSON body; search parameters in the URL query are ignored. The request body must be a single JSON object; use {} for no filters.

クエリパラメーター

Parameter	Type	Required	Description
`identity_id`	string	No	Identity に属するリソースを操作する場合のみ使用する任意のパラメーターです。PAT では明示的に指定でき、省略時は管理者スコープになります。SAT では Identity スコープのトークンを発行し、このパラメーターを明示的に指定しないでください。指定すると HTTP 400 が返されます。Identity の帰属.

Without identity_id, a PAT searches Vaults owned by the current account or Workspace. With it, a PAT searches only the specified Identity. Admin SAT searches only the Workspace; Identity SAT searches only the token-bound Identity. Resources in other scopes are excluded.

リクエストボディ

パラメーター	型	説明
`metadata`	object<string,string>	metadata の完全一致条件です。複数の条件は AND で結合されます。最大 16 件。
`limit`	integer	ページサイズです。デフォルトは 20、範囲は 1～100。
`page`	string	前のレスポンスの `next_page` で返されたカーソルです。
`include_archived`	boolean	CAS と Forward の両方から参照可能なアーカイブ済み Vault を含めるかどうかです。デフォルトは `false`。
`name`	string	表示名に対する大文字と小文字を区別しない部分一致です。最大 255 文字。

curl -X POST "https://api.qoder.com/api/v1/forward/vaults/search" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -H "x-qoder-beta: search-2026-08-31" \
  -d '{"metadata":{"team":"core"},"name":"production","limit":20}'

レスポンス

フィールド	型	説明
`data`	array	現在のページで Forward から参照可能なリソースの一覧です。リソースのフィールドは対応する一覧取得 API と同じです。
`first_id`	string \| null	現在のページの最初のリソース ID。
`last_id`	string \| null	現在のページの最後のリソース ID。
`has_more`	boolean	Forward から参照可能なリソースの次のページが存在することが確認されているかどうかです。
`next_page`	string \| null	次のページのカーソルです。次のページがない場合は `null`。

{
  "data": [],
  "first_id": null,
  "has_more": false,
  "last_id": null,
  "next_page": null
}

data 内のリソースフィールドは Vault の一覧取得と同じです。 metadata のキーは 1～64 文字で、空白文字だけにすることはできません。値は最大 512 文字の文字列である必要があります。クライアントは返された next_page をそのまま再送し、カーソルを独自に生成しないでください。

エラー

HTTP	Type	発生条件
400	`invalid_request_error`	The Beta header or request body is missing, or a search parameter is invalid. SAT が `identity_id` を明示的に指定した場合も返されます。
401	`authentication_error`	認証トークンがないか、無効です。
403	`permission_error`	呼び出し元にはこのリソースへのアクセス権限がありません。
404	`not_found_error`	The PAT-specified `identity_id` does not exist, is disabled, deleted, or does not belong to the caller.
429	`rate_limit_error`	Forward または依存サービスのレート制限を超えました。
500/502/503	`api_error`	Forward または依存サービスでエラーが発生しました。

​クエリパラメーター

​リクエストボディ

​レスポンス

​エラー

クエリパラメーター

リクエストボディ

レスポンス

エラー