OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要
このグループには 4 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。
大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。
監査ログ: すべての設定変更を変更前と変更後とともに記録し、検証できるハッシュチェーンと CSV、XLSX、PDF のエクスポートを備えています
監査ログを一覧表示
プロジェクトの設定変更を新しい順に一覧表示します。誰が、何を、いつ、どの画面から変更したかを、フィールド単位の変更前と変更後とともに、すべてのプランで 400 日間保持します。
actor (id)、actor_kind、source、resource_type、resource_id、action（完全一致、または * で終わるプレフィックス）、field（/label のような JSON ポインターのプレフィックス）、since/until の期間で絞り込み、cursor でページを送ります。format に csv、xlsx、pdf を指定すると、絞り込んだログをレポートのレンダラーでファイルに書き出します（変更されたフィールドごとに 1 行、古い順で、since の指定がなければ直近 30 日。チェーンの先頭と保持の下限がファイルに含まれるため、audit verify のアンカーになります）。
シークレット（トークン、キー、パスワード、Webhook やソースの認証情報）は (redacted) と表示されます。それ以外の値は保存されている値です。エントリは変更を行うトランザクション内でサービスが書き込み、エントリを書き込み、更新、削除するものはありません。
プロジェクト権限が必要です。ダッシュボードのセッションでは、プロジェクトのオーナー、組織の管理者、またはプロジェクトを代行表示しているスタッフとして読み取ります。ログの読み取りとエクスポートは、Enterprise プランに含まれる監査ログです。プランにこの機能が含まれていないプロジェクトは feature_not_in_plan（402）で拒否されます。すべてのプランで変更が記録されます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| 操作者 | クエリ | オプション | 操作者の ID（ユーザー、エージェント、またはサービスクライアント）。 |
| actor_kind | クエリ | オプション | |
| ソース | クエリ | オプション | |
| resource_type | クエリ | オプション | |
| resource_id | クエリ | オプション | |
| アクション | クエリ | オプション | screen.update のようなアクションコード、または playlist.* のようなプレフィックス。 |
| field | クエリ | オプション | JSON ポインター: このメンバーまたはその配下のメンバーを変更したエントリ（例: /label）。 |
| 以降 | クエリ | オプション | |
| まで | クエリ | オプション | |
| カーソル | クエリ | オプション | 前のページの next_cursor。同じフィルター付き。不透明。 |
| 制限 | クエリ | オプション | |
| フォーマット | クエリ | オプション | json（既定）はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します（ページ分割されたレポートは全ページ、最大 50000 行）。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | エントリの 1 ページ。csv、xlsx、pdf では絞り込んだログのファイル。 | AuditList（application/json）, string（text/csv）, string（application/vnd.openxmlformats-officedocument.spreadsheetml.sheet）, string（application/pdf） |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 402 | feature_not_in_plan — 監査ログは Enterprise プランに含まれます。問題には、機能、アカウントのプラン、required_plan が示されます。 | 問題 (application/problem+json) |
| 404 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
監査の先頭を取得
プロジェクトの監査チェーンの先頭（最後にチェーンされたエントリの seq と hash）、チェーンの起点となる保持下限、チェーン待ちのエントリ数。先頭をアンカーとして保存しておき、後で GET /api/audit/verify に渡すと、それ以前の履歴が書き換えられたり削除されたりしていないことを証明できます。
Enterprise プランに含まれる監査ログの一部です。プランにこの機能が含まれていないプロジェクトは feature_not_in_plan（402）で拒否されます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/head'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | チェーンの先頭。 | AuditHead（application/json） |
| 402 | feature_not_in_plan — 監査ログは Enterprise プランに含まれます。問題には、機能、アカウントのプラン、required_plan が示されます。 | 問題 (application/problem+json) |
| 404 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
監査ログを検証
ある範囲の監査ハッシュチェーンを再計算し、問題があれば報告します。
チェーンされた各エントリのハッシュは保存されている内容から再計算され、各エントリは直前のエントリにリンクし、seq は保持の下限から連続し、最後のエントリはチェーンの先頭でなければなりません。anchor（以前のエクスポートまたは head の SEQ:HASH）を指定すると、その seq のエントリが変更されておらず、それ以前でチェーンが切り詰められていないことも証明されます。
1 回の呼び出しで確認するのは最大 5000 件です。続きは next_seq から from_seq を指定します。Enterprise プランに含まれる監査ログの一部です。プランにこの機能が含まれていないプロジェクトは feature_not_in_plan（402）で拒否されます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| from_seq | クエリ | オプション | 確認する最初のチェーン位置。既定は保持されている最も古い位置です。 |
| 制限 | クエリ | オプション | |
| アンカー | クエリ | オプション | 保管しているチェーンの先頭の SEQ:HASH。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/verify'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 検証結果。 | AuditVerifyResult（application/json） |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 402 | feature_not_in_plan — 監査ログは Enterprise プランに含まれます。問題には、機能、アカウントのプラン、required_plan が示されます。 | 問題 (application/problem+json) |
| 404 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
監査エントリを取得
フィールド単位の変更を含む 1 件の監査エントリ。Enterprise プランに含まれる監査ログの一部です。プランにこの機能が含まれていないプロジェクトは feature_not_in_plan（402）で拒否されます。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/audit/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | エントリ。 | AuditEntry（application/json） |
| 402 | feature_not_in_plan — 監査ログは Enterprise プランに含まれます。問題には、機能、アカウントのプラン、required_plan が示されます。 | 問題 (application/problem+json) |
| 404 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |