OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要
このグループには 9 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。
大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。
サービスクライアント
サービスクライアント一覧
プロジェクトのサービスクライアント（仕様：プロジェクトが所有する顧客のサーバー、スクリプト、CIジョブ）、新しい順、ライブと取り消し済み、公開鍵、秘密ID、使用状況を含みます。秘密やダイジェストは含みません。プロジェクト機能が必要です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/service-clients'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | サービスクライアント。 | ServiceClientList（application/json） |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
サービスクライアントを作成
名前、機能（省略時は6つすべて。各機能はマネージャーが持つものに限り、そうでなければ403）、アクセス権（既定は読み取り、または管理）、および公開JWKキー（OKP Ed25519、EC P-256、または2048ビット以上のRSA）および/またはシークレットtrueを持つプロジェクト所有のサービスクライアントを作成します。シークレットは一度だけここで返されます。組織あたり最大50のライブクライアント。
エージェントはアイデンティティスコープ、ライブアイデンティティ管理、プロジェクトのプロジェクト機能を持つ自身の管理権限、ライブ組織の管理者ロールが必要です；ユーザーはproject_idと新しい証明（種類service_client_change、クライアントIDまたは作成時はプロジェクトID）をボディに持つダッシュボードセッションを使用します。サービストークンは403で拒否されます。
スクリーンに限定されたメンバーは、エージェントの接続、資格情報の発行、プロジェクトのユーザー管理を行えません：outside_screen_scope（プロジェクトオーナーに依頼してください）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| project_id（任意、文字列） | ダッシュボード セッションのみ。 |
| proof（任意、DashboardProof） | |
| name（任意、文字列） | minLength: 1 maxLength: 80 |
| 機能（任意、配列） | |
| アクセス（任意、文字列） | 管理はレビュー承認可能な人が必要です（403 approver_required）。許可されるのは「read」、「propose」、「manage」です。 |
| key（任意、オブジェクト） | 公開JWK：OKP Ed25519、EC P-256、または2048ビット以上のRSA。 |
| secret（任意、真偽値） | シークレットを生成（作成のみ）。 |
| upload_scope（任意、UploadScope） | アップローダーが使えるもの（docs/uploaders.md）：ページを変更できるプレイリストと、アップロード先のメディアフォルダー。フォルダーは一覧されたものそのもので、サブフォルダーは含まれません。書き込み時にプロジェクトの有効なオブジェクトを指していないIDは、その位置で invalid_request になります。後から削除されたものは無効なIDとして残りますが、何も許可しません。 範囲はリクエストごとに読み込まれるため、変更は次のリクエストから適用されます。 |
リクエストテンプレートとレスポンス
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 201 | サービスクライアント。 | ServiceClientResult（application/json） |
| 402 | feature_not_in_plan — アップロードスコープはアップローダーを作り、プロジェクトのプランにはアップローダーが含まれていません。required_plan が、含まれるプランを示します。スコープの絞り込みと削除は常に許可されます。 | 問題 (application/problem+json) |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (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つのサービスクライアント。プロジェクト能力が必要です。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | サービスクライアント。 | ServiceClient（application/json） |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
サービスクライアントを更新
サービスクライアントの名前を変更するか、マネージャーの範囲内で機能やアクセスを変更します。いずれかを狭めると、クライアントの現在のトークンは数秒以内に無効になります。
エージェントはアイデンティティスコープ、ライブアイデンティティ管理、プロジェクトのプロジェクト機能を持つ自身の管理権限、ライブ組織の管理者ロールが必要です；ユーザーはproject_idと新しい証明（種類service_client_change、クライアントIDまたは作成時はプロジェクトID）をボディに持つダッシュボードセッションを使用します。サービストークンは403で拒否されます。
スクリーンに限定されたメンバーは、エージェントの接続、資格情報の発行、プロジェクトのユーザー管理を行えません：outside_screen_scope（プロジェクトオーナーに依頼してください）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| project_id（任意、文字列） | ダッシュボード セッションのみ。 |
| proof（任意、DashboardProof） | |
| name（任意、文字列） | minLength: 1 maxLength: 80 |
| 機能（任意、配列） | |
| アクセス（任意、文字列） | 管理はレビュー承認可能な人が必要です（403 approver_required）。許可されるのは「read」、「propose」、「manage」です。 |
| key（任意、オブジェクト） | 公開JWK：OKP Ed25519、EC P-256、または2048ビット以上のRSA。 |
| secret（任意、真偽値） | シークレットを生成（作成のみ）。 |
| upload_scope（任意、UploadScope） | アップローダーが使えるもの（docs/uploaders.md）：ページを変更できるプレイリストと、アップロード先のメディアフォルダー。フォルダーは一覧されたものそのもので、サブフォルダーは含まれません。書き込み時にプロジェクトの有効なオブジェクトを指していないIDは、その位置で invalid_request になります。後から削除されたものは無効なIDとして残りますが、何も許可しません。 範囲はリクエストごとに読み込まれるため、変更は次のリクエストから適用されます。 |
リクエストテンプレートとレスポンス
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | サービスクライアント。 | ServiceClientResult（application/json） |
| 402 | feature_not_in_plan — アップロードスコープはアップローダーを作り、プロジェクトのプランにはアップローダーが含まれていません。required_plan が、含まれるプランを示します。スコープの絞り込みと削除は常に許可されます。 | 問題 (application/problem+json) |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
サービスクライアントキーを追加
ゼロダウンタイムローテーション用に2つ目の公開 JWK（本文内のキー）を登録します。クライアントは最大2つ保持します。
エージェントはアイデンティティスコープ、ライブアイデンティティ管理、プロジェクトのプロジェクト機能を持つ自身の管理権限、ライブ組織の管理者ロールが必要です；ユーザーはproject_idと新しい証明（種類service_client_change、クライアントIDまたは作成時はプロジェクトID）をボディに持つダッシュボードセッションを使用します。サービストークンは403で拒否されます。
スクリーンに限定されたメンバーは、エージェントの接続、資格情報の発行、プロジェクトのユーザー管理を行えません：outside_screen_scope（プロジェクトオーナーに依頼してください）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| project_id（任意、文字列） | ダッシュボード セッションのみ。 |
| proof（任意、DashboardProof） | |
| name（任意、文字列） | minLength: 1 maxLength: 80 |
| 機能（任意、配列） | |
| アクセス（任意、文字列） | 管理はレビュー承認可能な人が必要です（403 approver_required）。許可されるのは「read」、「propose」、「manage」です。 |
| key（任意、オブジェクト） | 公開JWK：OKP Ed25519、EC P-256、または2048ビット以上のRSA。 |
| secret（任意、真偽値） | シークレットを生成（作成のみ）。 |
| upload_scope（任意、UploadScope） | アップローダーが使えるもの（docs/uploaders.md）：ページを変更できるプレイリストと、アップロード先のメディアフォルダー。フォルダーは一覧されたものそのもので、サブフォルダーは含まれません。書き込み時にプロジェクトの有効なオブジェクトを指していないIDは、その位置で invalid_request になります。後から削除されたものは無効なIDとして残りますが、何も許可しません。 範囲はリクエストごとに読み込まれるため、変更は次のリクエストから適用されます。 |
リクエストテンプレートとレスポンス
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/keys'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | サービスクライアント。 | ServiceClientResult（application/json） |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (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つのキーまたはシークレットを保持します。
エージェントはアイデンティティスコープ、ライブアイデンティティ管理、プロジェクトのプロジェクト機能を持つ自身の管理権限、ライブ組織の管理者ロールが必要です；ユーザーはproject_idと新しい証明（種類service_client_change、クライアントIDまたは作成時はプロジェクトID）をボディに持つダッシュボードセッションを使用します。サービストークンは403で拒否されます。
スクリーンに限定されたメンバーは、エージェントの接続、資格情報の発行、プロジェクトのユーザー管理を行えません：outside_screen_scope（プロジェクトオーナーに依頼してください）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| kid | パス | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| project_id（任意、文字列） | ダッシュボード セッションのみ。 |
| proof（任意、DashboardProof） | |
| name（任意、文字列） | minLength: 1 maxLength: 80 |
| 機能（任意、配列） | |
| アクセス（任意、文字列） | 管理はレビュー承認可能な人が必要です（403 approver_required）。許可されるのは「read」、「propose」、「manage」です。 |
| key（任意、オブジェクト） | 公開JWK：OKP Ed25519、EC P-256、または2048ビット以上のRSA。 |
| secret（任意、真偽値） | シークレットを生成（作成のみ）。 |
| upload_scope（任意、UploadScope） | アップローダーが使えるもの（docs/uploaders.md）：ページを変更できるプレイリストと、アップロード先のメディアフォルダー。フォルダーは一覧されたものそのもので、サブフォルダーは含まれません。書き込み時にプロジェクトの有効なオブジェクトを指していないIDは、その位置で invalid_request になります。後から削除されたものは無効なIDとして残りますが、何も許可しません。 範囲はリクエストごとに読み込まれるため、変更は次のリクエストから適用されます。 |
リクエストテンプレートとレスポンス
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/keys/KID/remove'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | サービスクライアント。 | ServiceClientResult（application/json） |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
サービスクライアントシークレットを追加
ゼロダウンタイムローテーション用に2つ目のシークレットを生成し、一度だけ返します。クライアントは最大2つ保持します。
エージェントはアイデンティティスコープ、ライブアイデンティティ管理、プロジェクトのプロジェクト機能を持つ自身の管理権限、ライブ組織の管理者ロールが必要です；ユーザーはproject_idと新しい証明（種類service_client_change、クライアントIDまたは作成時はプロジェクトID）をボディに持つダッシュボードセッションを使用します。サービストークンは403で拒否されます。
スクリーンに限定されたメンバーは、エージェントの接続、資格情報の発行、プロジェクトのユーザー管理を行えません：outside_screen_scope（プロジェクトオーナーに依頼してください）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| project_id（任意、文字列） | ダッシュボード セッションのみ。 |
| proof（任意、DashboardProof） | |
| name（任意、文字列） | minLength: 1 maxLength: 80 |
| 機能（任意、配列） | |
| アクセス（任意、文字列） | 管理はレビュー承認可能な人が必要です（403 approver_required）。許可されるのは「read」、「propose」、「manage」です。 |
| key（任意、オブジェクト） | 公開JWK：OKP Ed25519、EC P-256、または2048ビット以上のRSA。 |
| secret（任意、真偽値） | シークレットを生成（作成のみ）。 |
| upload_scope（任意、UploadScope） | アップローダーが使えるもの（docs/uploaders.md）：ページを変更できるプレイリストと、アップロード先のメディアフォルダー。フォルダーは一覧されたものそのもので、サブフォルダーは含まれません。書き込み時にプロジェクトの有効なオブジェクトを指していないIDは、その位置で invalid_request になります。後から削除されたものは無効なIDとして残りますが、何も許可しません。 範囲はリクエストごとに読み込まれるため、変更は次のリクエストから適用されます。 |
リクエストテンプレートとレスポンス
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/secrets'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | サービスクライアント。 | ServiceClientResult（application/json） |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
サービスクライアントシークレットを削除
シークレットを削除します。クライアントの現在のトークンは数秒で終了します。
エージェントはアイデンティティスコープ、ライブアイデンティティ管理、プロジェクトのプロジェクト機能を持つ自身の管理権限、ライブ組織の管理者ロールが必要です；ユーザーはproject_idと新しい証明（種類service_client_change、クライアントIDまたは作成時はプロジェクトID）をボディに持つダッシュボードセッションを使用します。サービストークンは403で拒否されます。
スクリーンに限定されたメンバーは、エージェントの接続、資格情報の発行、プロジェクトのユーザー管理を行えません：outside_screen_scope（プロジェクトオーナーに依頼してください）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 | |
| secret_id | パス | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| project_id（任意、文字列） | ダッシュボード セッションのみ。 |
| proof（任意、DashboardProof） | |
| name（任意、文字列） | minLength: 1 maxLength: 80 |
| 機能（任意、配列） | |
| アクセス（任意、文字列） | 管理はレビュー承認可能な人が必要です（403 approver_required）。許可されるのは「read」、「propose」、「manage」です。 |
| key（任意、オブジェクト） | 公開JWK：OKP Ed25519、EC P-256、または2048ビット以上のRSA。 |
| secret（任意、真偽値） | シークレットを生成（作成のみ）。 |
| upload_scope（任意、UploadScope） | アップローダーが使えるもの（docs/uploaders.md）：ページを変更できるプレイリストと、アップロード先のメディアフォルダー。フォルダーは一覧されたものそのもので、サブフォルダーは含まれません。書き込み時にプロジェクトの有効なオブジェクトを指していないIDは、その位置で invalid_request になります。後から削除されたものは無効なIDとして残りますが、何も許可しません。 範囲はリクエストごとに読み込まれるため、変更は次のリクエストから適用されます。 |
リクエストテンプレートとレスポンス
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/secrets/SECRET_ID/remove'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | サービスクライアント。 | ServiceClientResult（application/json） |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
サービスクライアントを取り消す
サービスクライアントを永久に取り消します：キーとシークレットダイジェストを削除し、記録は監査用に保持し、トークンは数秒以内に終了します（伝播済みまたは保留中）。
エージェントはアイデンティティスコープ、ライブアイデンティティ管理、プロジェクトのプロジェクト機能を持つ自身の管理権限、ライブ組織の管理者ロールが必要です；ユーザーはproject_idと新しい証明（種類service_client_change、クライアントIDまたは作成時はプロジェクトID）をボディに持つダッシュボードセッションを使用します。サービストークンは403で拒否されます。
スクリーンに限定されたメンバーは、エージェントの接続、資格情報の発行、プロジェクトのユーザー管理を行えません：outside_screen_scope（プロジェクトオーナーに依頼してください）。
パラメーター
| 名前 | 送信する | 必須？ | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| ID | パス | 必須 |
リクエスト本文フィールド
| フィールド | 説明 |
|---|---|
| project_id（任意、文字列） | ダッシュボード セッションのみ。 |
| proof（任意、DashboardProof） | |
| name（任意、文字列） | minLength: 1 maxLength: 80 |
| 機能（任意、配列） | |
| アクセス（任意、文字列） | 管理はレビュー承認可能な人が必要です（403 approver_required）。許可されるのは「read」、「propose」、「manage」です。 |
| key（任意、オブジェクト） | 公開JWK：OKP Ed25519、EC P-256、または2048ビット以上のRSA。 |
| secret（任意、真偽値） | シークレットを生成（作成のみ）。 |
| upload_scope（任意、UploadScope） | アップローダーが使えるもの（docs/uploaders.md）：ページを変更できるプレイリストと、アップロード先のメディアフォルダー。フォルダーは一覧されたものそのもので、サブフォルダーは含まれません。書き込み時にプロジェクトの有効なオブジェクトを指していないIDは、その位置で invalid_request になります。後から削除されたものは無効なIDとして残りますが、何も許可しません。 範囲はリクエストごとに読み込まれるため、変更は次のリクエストから適用されます。 |
リクエストテンプレートとレスポンス
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/revoke'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | サービスクライアント。 | ServiceClientResult（application/json） |
| 403 | outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です（docs/screen-scope.md）。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。 | 問題 (application/problem+json) |
| デフォルト | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |