API リファレンス

ダッシュボード API

人々とプロジェクトダッシュボード

HTTP リファレンス。 バックエンド契約から生成。以下のエンドポイントを参照するか、OpenAPI をダウンロードしてください。

このグループには 94 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。

大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。

人々とプロジェクトダッシュボード

POST/api/invitations/inspect

ダッシュボード招待を検査

招待を消費せずに検査します。サインアップや検証状態は報告しません。ただし、サインインリセットは replaces_unverified_account を報告します。organization_admin または organization_member の招待は、組織名を報告し、プロジェクトは報告しません。

認証
なし
リクエスト本文
InvitationInspectRequest
操作ID
inspectDashboardInvitation

リクエスト本文フィールド

フィールド説明
トークン(必須、文字列)パターン: "^[A-Za-z0-9_-]{43}$"
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/invitations/inspect'

レスポンス

ステータス意味本文とヘッダー
200招待を消費せずに検査。InvitationInspect(application/json);ヘッダー:RateLimit-Policy、RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
POST/api/invitations/passkey-options

ダッシュボード招待パスキー開始

招待ダイジェストとモードに紐づく5分間の登録セレモニーを開始します。リンク create_login は検証済みの __Host-screenrig-signup クッキーを必要とし、その名前を使用します。

メール create_login は提供された表示名を紐づけ、リセットは対象のユーザーを紐づけます。ただし、未検証のアドレスのリセットでは、それが作成する新しいユーザーのパスキーを登録し、そのユーザーの名前は提供された表示名、省略した場合はアドレスから付けられます。

そのリセットには replace_unverified_account を true にする必要があります(検査で replaces_unverified_account が報告されます)。指定しない場合は 409 unverified_account_replacement を返します。

認証
なし または invitationSignup
リクエスト本文
招待パスキーオプションリクエスト
操作ID
startDashboardInvitationPasskey

リクエスト本文フィールド

フィールド説明
トークン(必須、文字列)パターン: "^[A-Za-z0-9_-]{43}$"
mode(必須、文字列)許可:"create_login"、"reset"
display_name(任意、DashboardDisplayName)トリムされた印刷可能な表示名、最大80バイトのUTF-8。制御文字、URLのようなテキスト、@、www.、://、認証情報は拒否します。認証は絶対に含みません。minLength:1 maxLength:80
replace_unverified_account(任意、ブール値)

サインインリセットのみ(mode は reset。他のモードでは拒否されます)。検査で replaces_unverified_account が true と報告された場合は true にする必要があります。これは、そのアドレスが保持する未検証のアカウントの代わりに新しい空のアカウントを持つことへの本人の同意です。省略または false の場合は 409 unverified_account_replacement を返し、セレモニーを開始しません。

リセットが何も置き換えない場合は無視されます。デフォルト:false

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/invitations/passkey-options'

レスポンス

ステータス意味本文とヘッダー
201招待ダイジェストとモードに紐づく5分間の登録セレモニーを開始します。ダッシュボードパスキー登録(application/json);ヘッダー:RateLimit-Policy、RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
POST/api/invitations/email-verifications

ダッシュボード招待メールを検証

ブラウザバウンドリンクのサインアップを開始し、この招待の以前のサインアップを取り消します。検証チャレンジはこのサインアップに紐づきます。開発認証はメールなしで即座にサインアップを検証します。

認証
なし
リクエスト本文
InvitationEmailVerificationRequest
操作ID
verifyDashboardInvitationEmail

リクエスト本文フィールド

フィールド説明
トークン(必須、文字列)パターン: "^[A-Za-z0-9_-]{43}$"
display_name(必須、DashboardDisplayName)トリムされた印刷可能な表示名、最大80バイトのUTF-8。制御文字、URLのようなテキスト、@、www.、://、認証情報は拒否します。認証は絶対に含みません。minLength:1 maxLength:80
email(必須、文字列)minLength: 3 maxLength: 254 形式: "email"
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/invitations/email-verifications'

レスポンス

ステータス意味本文とヘッダー
202ブラウザバウンドリンクのサインアップを開始し、この招待の以前のサインアップを取り消します。InvitationEmailVerificationAccepted(application/json);ヘッダー:Set-Cookie、RateLimit-Policy、RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
GET/api/invitations/signup

ダッシュボード招待サインアップを取得

このブラウザーに属するライブサインアップを返します。サインアップCookieが欠落、取り消し、使用済み、または期限切れの場合はinvitation_invalidを返します。

認証
invitationSignup
リクエスト本文
なし
操作ID
getDashboardInvitationSignup
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/invitations/signup'

レスポンス

ステータス意味本文とヘッダー
200このブラウザーに属するライブサインアップを返します。招待サインアップ(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/invitations/accept

ダッシュボード招待を承諾する

招待をトランザクション的に承諾し、新しいユーザーセッションを発行し、既存のセッションがあれば削除します。

リンク create_login には、この招待に対して検証済みの __Host-screenrig-signup クッキーが必要です。signed_in にはダッシュボードセッションと最近のサインインまたは新しい証明が必要です。メール配信には、一致する検証済みメール、またはサインイン中のユーザーの未検証アドレスが必要で、承諾するとそのアドレスが検証されます。

有効なユーザーがすでに保持しているアドレスは、検証済みかどうかにかかわらず、create_login に対して resource_conflict を返します。リセットは、検証済みアドレスを保持するユーザーをサインインさせます。

未検証のアドレスのリセットには replace_unverified_account を true にする必要があります(検査で replaces_unverified_account が報告されます)。指定しない場合は 409 unverified_account_replacement を返し、何も消費しません。指定した場合、リセットは、登録された認証情報を持つ新しい検証済みユーザーを作成し(名前は display_name、省略した場合はアドレスから付けます)、新しい組織とプロジェクトを用意して、そのユーザーをサインインさせます。未検証のユーザーは削除され(そのセッション、パスキー、エージェントは終了します)、そのユーザーが作成したプロジェクトと組織は、そのユーザーを除いた状態で残ります。これらのプロジェクトの連絡先アドレスはそのアドレスと一致しなくなるため、以降のリセットで登録の招待が再送されることはありません。

レスポンスには新しいプロジェクトが示されます。メールアドレスの検証が必要なセッション(GET /api/session の email_verification_required)は、自身のアドレス宛てにメールで送られた招待のみを受け付け、それ以外には 403 email_verification_required を受け取ります。

organization_admin の招待は、ユーザーを組織の管理者に追加し、プロジェクトは開きません。組織にすでに 20 人の管理者がいる場合は organization_admin_limit を返して未処理のままとなり、組織が削除されている場合は resource_conflict を返します。

organization_member 招待は、以前のホーム組織があってもそれに代えて、ユーザーのホーム組織を招待した組織に設定し、プロジェクトメンバーシップは付与しません。別の組織がユーザーを管理している場合は managed_elsewhere(409)を、組織が削除されている場合は resource_conflict を返します。

organization_admin 招待は、ホーム組織を持たないユーザーに対してのみホーム組織を設定します。project_member 招待は組織のゲストポリシーを再チェックし、ポリシーが拒否する外部ゲストとなるユーザーには guest_not_allowed(403)を返します。プロジェクト招待が誰かのホーム組織を変更することはありません。拒否された招待は未処理のままです。

認証
なし または invitationSignup または dashboardSession
リクエスト本文
InvitationAcceptRequest
操作ID
acceptDashboardInvitation

リクエスト本文フィールド

フィールド説明
トークン(必須、文字列)パターン: "^[A-Za-z0-9_-]{43}$"
mode(必須、文字列)許可:"create_login"、"signed_in"、"reset"
display_name(任意、DashboardDisplayName)トリムされた印刷可能な表示名、最大80バイトのUTF-8。制御文字、URLのようなテキスト、@、www.、://、認証情報は拒否します。認証は絶対に含みません。minLength:1 maxLength:80
credential(オプション、InvitationCredential)
proof(任意、DashboardProof)
buyer(任意、InvitationBuyer)
remove_other_passkeys(任意、真偽値)

サインインのリセットのみ(mode reset)。このリセットで登録するもの以外のパスキーを削除し、リセットでパスワードを設定する場合はすべてのパスキーを削除するため、紛失・盗難にあったデバイスではサインインできなくなります。省略時は true です。ほかの招待ではこの指定を拒否します。未確認のアドレスのリセットはほかのパスキーを持たない新しい人を作成するため、この指定は無視されます。

パスキーを登録するリセットでは、この値にかかわらずパスワードが削除されます。default: true

replace_unverified_account(任意、ブール値)

サインインリセットのみ(mode は reset。他の招待では拒否されます)。検査で replaces_unverified_account が true と報告された場合は true にする必要があります。これは、そのアドレスが保持する未検証のアカウントの代わりに新しい空のアカウントを持つことへの本人の同意です。省略または false の場合は 409 unverified_account_replacement を返し、何も消費しません。

リセットが何も置き換えない場合は無視されます。デフォルト:false

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/invitations/accept'

レスポンス

ステータス意味本文とヘッダー
200招待をトランザクション的に承諾し、新しいユーザーセッションを発行し、既存のセッションがあれば削除します。InvitationAccepted(application/json);ヘッダー:Set-Cookie、RateLimit-Policy、RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
POST/api/signups/passkey-options

ダッシュボードサインアップパスキー開始

セルフサービスのサインアップ用に、5分間の登録セレモニーを開始します。セレモニーは正規化されたメールアドレスと表示名に紐づきます。何も作成せず、メールも送信しません。

有効なユーザーが保持しているアドレスは、検証済みかどうかにかかわらず 409 account_exists を返します。組織が ID プロバイダー経由でサインインするドメインのアドレスは 403 sso_required を返します。無効なアドレスまたは名前は、フィールドエラー付きの 400 invalid_request を返します。ダッシュボード開発認証を実行しているサーバーは passkeys_disabled を返します。

クライアントアドレスごとに制限されます。

認証
なし
リクエスト本文
SignupPasskeyOptionsRequest
操作ID
startDashboardSignupPasskey

リクエスト本文フィールド

フィールド説明
email(必須、文字列)minLength: 3 maxLength: 254 形式: "email"
display_name(必須、DashboardDisplayName)トリムされた印刷可能な表示名、最大80バイトのUTF-8。制御文字、URLのようなテキスト、@、www.、://、認証情報は拒否します。認証は絶対に含みません。minLength:1 maxLength:80
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/signups/passkey-options'

レスポンス

ステータス意味本文とヘッダー
201セルフサービスのサインアップ用に、5分間の登録セレモニーを開始します。ダッシュボードパスキー登録(application/json);ヘッダー:RateLimit-Policy、RateLimit
400

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
403

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
409

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/signups

ダッシュボードサインアップを作成

セルフサービスのアカウントを作成し、このブラウザーでサインインします。

1つのトランザクションで、未検証のメールアドレスと72時間後の検証期限を持つユーザーを作成し、POST /api/signups/passkey-options が開始したセレモニーのパスキーを登録し、エージェント登録が作成するのと同じ方法でユーザーの組織とプロジェクトを作成し、ユーザーをプロジェクトのオーナーにし、マーケティングメールの選択を保存し、検証メールをキューに入れます(purpose は account_email)。

ページを開いたウェブサイト訪問者がアカウントに関連付けられ、サインアップは signed_up として計上されます。レスポンスはダッシュボードのセッションクッキーを設定します。拒否の条件は POST /api/signups/passkey-options と同じです。使用済み、期限切れ、または一致しないセレモニーは 400 invalid_request を返します。クライアントアドレスごと、およびメールアドレスごとに制限されます。

認証
なし
リクエスト本文
SignupRequest
操作ID
createDashboardSignup

リクエスト本文フィールド

フィールド説明
email(必須、文字列)minLength: 3 maxLength: 254 形式: "email"
display_name(必須、DashboardDisplayName)トリムされた印刷可能な表示名、最大80バイトのUTF-8。制御文字、URLのようなテキスト、@、www.、://、認証情報は拒否します。認証は絶対に含みません。minLength:1 maxLength:80
marketing_email(必須、ブール値)ユーザーがメールで製品ニュースを受け取ることを選択しました。同意としてユーザーとともに保存されます。
credential(必須、DashboardPasskeyProof)
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/signups'

レスポンス

ステータス意味本文とヘッダー
201アカウントが存在し、このブラウザーがそのセッションを保持しています。SignupCreated(application/json);ヘッダー:Cache-Control、Set-Cookie、RateLimit-Policy、RateLimit
400

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
403

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
409

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/session/project

ダッシュボードプロジェクトを切り替え

ユーザーのプロジェクトの1つに切り替え、最終使用時間を更新します。スタッフはシャドウしているプロジェクトに切り替えることもできます。そのセッションはshadow true、読み取り専用で最終使用時間を更新しません。他のプロジェクトはnot_foundを返します。

認証
dashboardSession
リクエスト本文
ダッシュボードプロジェクト切替
操作ID
switchDashboardProject

リクエスト本文フィールド

フィールド説明
project_id(必須、文字列)minLength: 1
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/session/project'

レスポンス

ステータス意味本文とヘッダー
200ユーザーのプロジェクトの1つに切り替え、最終使用時間を更新します。ダッシュボードセッション(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/members

ダッシュボードメンバー一覧

現在のプロジェクトのメンバーをプライベートメールアドレスなしで一覧表示

メンバー管理(削除、承認者、スコープ、所有権)を除き、すべてのメンバーは同等の権限を持ちます。メンバー管理は、オーナーと、メンバーでもあるプロジェクトの組織の管理者に属します。owner はプロジェクトオーナーを、external はゲスト(メンバーのホーム組織がプロジェクトの組織ではない)を示し、viewer_user_id と viewer_is_owner はサインインしているユーザーを示します。

認証
dashboardSession
リクエスト本文
なし
操作ID
listDashboardMembers
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/members'

レスポンス

ステータス意味本文とヘッダー
200現在のプロジェクトのメンバーをプライベートメールアドレスなしで一覧表示ダッシュボードメンバーリスト(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/members/{user_id}

ダッシュボードメンバーを削除

現在のプロジェクトからメンバーを削除します。プロジェクトオーナーは他のメンバーを削除でき、メンバーでもあるプロジェクトの組織の管理者も同様です。メンバーは自分自身を削除して退出できます。オーナーは削除も退出もしません(owner_cannot_leave。まず所有権を移譲してください)。他のメンバーを削除しようとする人は owner_required で拒否されます。

メンバーでないユーザー(すでに削除された人を含む)は not_found です。1つのトランザクションでメンバーシップが終了し、そのユーザーのプロジェクトへの未処理のメール招待が取り消され、プロジェクトイベント member.removed が追加されます(詳細は user_id、removed_by_user_id、left)。

ユーザーのセッションは次のリクエストでプロジェクトの解決を停止し、プロジェクト削除後と同様にフォールバックします。エージェントのメンバーシップは別であり、残ります。対象は人のみで、ベアラールートはありません。

認証
dashboardSession
リクエスト本文
なし
操作ID
removeDashboardMember

パラメーター

名前送信する必須?説明
user_idパス必須
project_idクエリ必須呼び出し元が意味するプロジェクト。選択が変わったセッションはresource_conflictで拒否されます。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/members/USER_ID?project_id=PROJECT_ID'

レスポンス

ステータス意味本文とヘッダー
204メンバーシップが終了しました。本文なし
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/members/{user_id}/activity

メンバーのアクティビティ一覧

現在のプロジェクトにおける1人の活動、最新順:サインイン(拒否されたサインインはアドレスまたはパスキー名付き)、サインアウト、プロジェクト切替、資格変更、再認証証明、ダッシュボード経由のすべての変更(拒否・失敗含む)。閲覧は記録されません。

AgentおよびCLIリクエストはそれぞれのエージェント上で処理されます(listDashboardAgentEvents)。スタッフのプロジェクトシャドウは記録を残さず、承認されたスタッフ書き込みリース下での変更はスタッフの行として記録されます。

その人自身、プロジェクトのオーナー、プロジェクト組織の管理者、プロジェクトを監視するスタッフメンバーのみが閲覧できます。その他はnot_foundで応答され、メンバーでない人やここに行がない人も同様で、誰が所属しているかは回答されません。元メンバーの行は読み取り可能なままです。

プロジェクトはセッションのものであり、リクエストのものではありません。常にそのプロジェクトの行のみが返されます。

すべての値はサーバー由来です:サーバーが一致させたルートのアクション(またはsession.sign_inやpasskey.addなどの名前付きアカウントアクション)、サーバー発行識別子の場合はルートの最初のパス値からのリソース、問題レジストリからのstatus、problem_code、error、User-Agentとプラットフォームヒントから解析されたクライアント(生のUser-Agentは保持しません)。

リクエストボディ、パスワード、トークン、クッキーは保存されません。client_ip と email は記録されたまま表示されます。

ページングキーは(at, id)降順です。続行するにはnext_cursorをafterとして渡します。終わりではnullです。書き込み中の行は最初のページの前にのみ入り、保持は最古の行を削除するため、カーソルは生存行を繰り返したりスキップしたりしません。不正なカーソルやフィルターはinvalid_requestで拒否されます。limitは1〜100のデフォルトです。

行は書き込まれた時点のプロジェクトのイベント保持期間で期限切れになります。recorded_since はプロジェクトの最古の生存行の時刻、またはそれ以前はこのサーバーの記録開始時刻です;それ以前は再構築されません。

認証
dashboardSession
リクエスト本文
なし
操作ID
listMemberActivity

パラメーター

名前送信する必須?説明
user_idパス必須
以降クエリオプション前のページのnext_cursorからのカーソル。
制限クエリオプション
種類クエリオプションこれらの種類のみ;パラメーターを繰り返すかカンマで区切って指定してください。
結果クエリオプション
resource_typeクエリオプションリクエストが作用したオブジェクトの正確な種類。
resource_idクエリオプションリクエストが作用したオブジェクトの正確な識別子。
以降クエリオプション
までクエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/members/USER_ID/activity'

レスポンス

ステータス意味本文とヘッダー
200その人の現在のプロジェクトでの活動。MemberActivityList(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/me

ダッシュボード自分を取得

サインインした人のプロフィールと資格カウントを返します。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardMe
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/me'

レスポンス

ステータス意味本文とヘッダー
200サインインした人のプロフィールと資格カウントを返します。ダッシュボード本人(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/me

ダッシュボード自分削除

サインインしているユーザーをトゥームストーンします。証明保護済み:本文には新しいサインイン証明が含まれ、これはPOST /api/me/reauthenticationsで開始されるaccount_delete種別とサインインユーザーIDと等しいsubject_idにバインドされた再認証で検証されます。現在の再認証がない場合はreauthentication_requiredを返します。

成功するとレスポンスは204で、ダッシュボードのセッションクッキーがクリアされ、サインアウト時と同様にブラウザのダッシュボードオリジンのHTTPキャッシュもクリアされます。

認証
dashboardSession
リクエスト本文
ダッシュボード証明要求
操作ID
deleteDashboardMe

リクエスト本文フィールド

フィールド説明
proof(必須、DashboardProof)
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me'

レスポンス

ステータス意味本文とヘッダー
204人物が削除され、ダッシュボードのセッションクッキーとこのオリジンのブラウザHTTPキャッシュがクリアされました。本文なし;ヘッダー:Clear-Site-Data
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/me/reauthentications

ダッシュボード再認証開始

セッション、種類、対象に紐づくパスキー昇格を開始します。パスキーを持たない人物は resource_conflict を受け取り、パスワード証明を使用します。

認証
dashboardSession
リクエスト本文
ダッシュボード再認証要求
操作ID
startDashboardReauthentication

リクエスト本文フィールド

フィールド説明
種類(必須、文字列)

許可:"agent_connection_approval"、"agent_connection_denial"、"agent_disconnect"、"email_change"、"password_set"、"passkey_add"、"passkey_delete"、"invitation_accept"、"account_delete"、"staff_grant"、"staff_action"、"staff_featuresets"、"staff_education_eligible"、"dashboard_token"、"oauth_authorization_approval"、"oauth_authorization_denial"、"service_client_change"、"review_policy_change"、"identity_provider_change"、"sso_policy_change"、"scim_change"

subject_id(オプション、文字列)

再認証が紐付く subject。kind が account_delete の場合は、サインイン中のユーザーの user id が必要です。kind が staff_grant の場合はスタッフ専用で、追加されるユーザーのメールアドレスが必要です。kind が staff_action の場合は、準備済みの特定の request_id が必要です。kind が staff_featuresets の場合はスタッフ専用で、組織 ID が必要です(その featuresets を置き換えます)。kind が staff_education_eligible の場合はスタッフ専用で、組織 ID が必要です(K-12 の学校または学区として認証済みの印を付ける、またはその印を外す場合)。kind が dashboard_token の場合はスタッフ専用で、サインイン中のスタッフの user id が必要です(ダッシュボードのリンクトークンの作成または置換)。kind が oauth_authorization_approval と oauth_authorization_denial の場合は、認可 ID(oaz_...)が必要です。kind が service_client_change の場合は、サービスクライアント ID が必要で、クライアントを作成する場合はプロジェクト ID が必要です。kind が review_policy_change の場合は、プロジェクト ID が必要です(エージェントによる変更にレビューを必須とする設定をオフにする場合)。kind が identity_provider_change、sso_policy_change、scim_change の場合は、組織 ID が必要です(組織の管理者が、シングルサインオン接続、Require SSO ポリシー、SCIM 設定とトークンを変更する場合)。シングルサインオンでサインインしたセッションは、代わりに {type: sso} で証明し、再認証を開始しません。minLength: 1

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/reauthentications'

レスポンス

ステータス意味本文とヘッダー
201セッション、種類、対象に紐づくパスキー昇格を開始します。ダッシュボード再認証(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/me/password

ダッシュボードパスワードを設定

新しい証明後にパスワードを設定または置換します。最初のパスワードはパスキー証明が必要で、置換は現在のパスワードまたはパスキーを受け入れます。他のセッションを取り消し、サインイン変更通知をキューに入れます。

メールアドレスが未検証のユーザー(検証前のセルフサービスサインアップなど)はパスワードを設定できず、403 email_verification_required を受け取ります。

認証
dashboardSession
リクエスト本文
ダッシュボードパスワード設定
操作ID
setDashboardPassword

リクエスト本文フィールド

フィールド説明
パスワード(必須、文字列)12~128バイトのUTF-8、空白なし。メールアドレス、表示名、一般的なパスワードとは一致できません。Argon2idハッシュとしてのみ保存されます。minLength:12 maxLength:128 パターン:"^\\S+$"
proof(必須、DashboardProof)
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/password'

レスポンス

ステータス意味本文とヘッダー
204新しい証明後にパスワードを設定または置換します。本文なし
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/me/passkeys

ダッシュボードパスキー一覧

ユーザーのパスキーを一覧表示します。ブラウザーのパスワードマネージャーをそれらと同期した状態に保つためにクライアントが必要とする情報も含まれます(WebAuthn Signal API)。一覧には、パスキーの登録先であるリライングパーティ ID とユーザーハンドルが含まれ、各パスキーには、その認証情報 ID と、認証器が報告したプロバイダーが含まれます。

認証
dashboardSession
リクエスト本文
なし
操作ID
listDashboardPasskeys
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/me/passkeys'

レスポンス

ステータス意味本文とヘッダー
200その人のパスキーを一覧表示します。ダッシュボードパスキーリスト(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/me/passkeys/options

ダッシュボードパスキー登録開始

新しい証明を検証し、セッションとユーザーに紐づく登録を開始します。開発認証下ではパスキーは無効です。

認証
dashboardSession
リクエスト本文
ダッシュボード証明要求
操作ID
startDashboardPasskeyRegistration

リクエスト本文フィールド

フィールド説明
proof(必須、DashboardProof)
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/passkeys/options'

レスポンス

ステータス意味本文とヘッダー
201新しい証明を検証し、セッションとユーザーに紐づく登録を開始します。ダッシュボードパスキー登録(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/me/passkeys/complete

Dashboard Passkey登録を完了

新しいパスキーを保存し、ユーザーの他のセッションを取り消し、サインイン変更通知をキューに入れます。名前なしで送信されたパスキーには、そのプロバイダー名が付けられます。認証器が既知のプロバイダーを報告しなかった場合は Passkey になります。

認証
dashboardSession
リクエスト本文
ダッシュボードパスキー完了
操作ID
completeDashboardPasskeyRegistration

リクエスト本文フィールド

フィールド説明
ceremony_id(必須、文字列)minLength: 1
credential(必須、オブジェクト)WebAuthn認証情報レスポンス。
name(任意、文字列)

ユーザーがパスキーに付ける名前。省略すると、パスキーにはそのプロバイダー名(例:iCloud Keychain)が付けられ、認証器が既知のプロバイダーを報告しなかった場合は Passkey になります。minLength: 1 maxLength: 60

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/passkeys/complete'

レスポンス

ステータス意味本文とヘッダー
201新しいパスキーを保存し、その人の他のセッションを取り消し、サインイン変更通知をキューに入れます。ダッシュボードパスキー(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PATCH/api/me/passkeys/{id}

ダッシュボードのパスキー名を変更

サインイン中のユーザーが所有するパスキーの名前を変更します。

認証
dashboardSession
リクエスト本文
ダッシュボードパスキーパッチ
操作ID
renameDashboardPasskey

パラメーター

名前送信する必須?説明
IDパス必須

リクエスト本文フィールド

フィールド説明
name(必須、文字列)minLength: 1 maxLength: 60
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/passkeys/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200サインイン中のユーザーが所有するパスキーの名前を変更します。ダッシュボードパスキー(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/me/passkeys/{id}

ダッシュボードパスキー削除

新しい証明後にパスキーを削除し、サインイン変更通知を送信します。最後のサインイン方法を削除するとlast_credentialが返されます。アカウントにパスキーが必要なユーザー(すべてのスタッフ)は最後のパスキーを削除できません。409 resource_conflictが返されます。

認証
dashboardSession
リクエスト本文
ダッシュボード証明要求
操作ID
deleteDashboardPasskey

パラメーター

名前送信する必須?説明
IDパス必須

リクエスト本文フィールド

フィールド説明
proof(必須、DashboardProof)
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/passkeys/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
204新しい証明後にパスキーを削除し、サインイン変更通知を送信します。本文なし
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/me/email

ダッシュボードメールを取得

ユーザーの検証済みと保留中のメールの状態を返します。自分でサインアップしたユーザーは、メールで送られたリンクを開くまで未検証のアドレスを保持します。email_verified は false で、verify_by が期限です。期限を過ぎると、セッションはアドレスを検証または変更するルートのみ使用できます(GET /api/session の email_verification_required)。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardEmail
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/me/email'

レスポンス

ステータス意味本文とヘッダー
200その人の検証済みおよび保留中のメール状態を返します。ダッシュボードメール(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/me/email/change

ダッシュボードのメールを変更

新しい証明を使ってメールアドレスの変更を要求します。検証中は検証済みのアドレスが有効です。他の有効なユーザーが保持するアドレスは、検証済みかどうかにかかわらず user_email_conflict を返します。古いアドレスには警告が送信され、元に戻すリンクはありません。

アドレスが未検証のユーザーも同じ方法で変更します。新しいアドレスを検証すると、それがそのユーザーの検証済みアドレスになり、verify_by が解除されます。

認証
dashboardSession
リクエスト本文
UserEmailChangeRequest
操作ID
changeDashboardEmail

リクエスト本文フィールド

フィールド説明
email(必須、文字列)minLength: 3 maxLength: 254 形式: "email"
proof(必須、DashboardProof)
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/email/change'

レスポンス

ステータス意味本文とヘッダー
202新しい証明を使ってメールアドレスの変更を要求します。UserEmailChangeAccepted(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/me/email/verification

ダッシュボードのメール検証をリクエスト

新しい検証リンクをキューに入れます。メール変更が検証待ち(GET /api/me/email の pending_email)の間は、その変更のリンクとして保留中のアドレスに送信されます。それ以外の場合は、ユーザーの現在の未検証アドレス宛ての account_email リンクです。同じ種類の直前のリンクから10分以内は何もキューに入れず、それでも 202 を返します。

アドレスが検証済みで、保留中の変更がないユーザーには 409 resource_conflict が返されます。

認証
dashboardSession
リクエスト本文
なし
操作ID
requestDashboardEmailVerification
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/me/email/verification'

レスポンス

ステータス意味本文とヘッダー
202検証リンクがキューに入りました。または、直近10分以内にキューに入っています。DashboardEmailVerificationAccepted(application/json)
409

安定した 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)
PUT/api/me/signup-profile

ダッシュボードサインアッププロフィールをPUT

サインアップ後にユーザーが答えた内容を、ここまでのすべての回答を含む本文で置き換えます。省略されたメンバーまたは null のメンバーは未回答です。各メンバーの値は閉じた集合で、その外の値はフィールドエラー付きの 400 invalid_request を返します。

プロフィールはユーザーとともに保存され、ユーザーがサインアップした組織とともに screenRIG スタッフに表示されます。

認証
dashboardSession
リクエスト本文
SignupProfile
操作ID
putDashboardSignupProfile

リクエスト本文フィールド

フィールド説明
who_for(任意、インライン)
use_case(任意、インライン)
screen_range(任意、インライン)
go_live(任意、インライン)
devices(任意、インライン)
role(任意、インライン)
firm_kind(任意、インライン)
agent(任意、インライン)
agent_other(任意、インライン)agent が other の場合のエージェントの名前。
heard(任意、インライン)
heard_detail(任意、インライン)
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/me/signup-profile'

レスポンス

ステータス意味本文とヘッダー
204プロフィールが保存されました。本文なし
400

安定した 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)
GET/api/applications/{id}/usage

ダッシュボードアプリケーション使用状況を取得

セッションのプロジェクトのアプリケーション(ウェブアプリ)が配置されている場所。プロジェクトのプレイリストを 1 回走査し、それらを保持するスクリーンを 1 回読み取って計算されます。placements は、保存されているアプリケーションオーナーがこのアプリケーションであるアプリケーションプリミティブで、プレイリスト(プレイリスト一覧の順序)、ページ、プリミティブの順に並びます。このアプリケーションを 2 回配置しているプレイリストには、配置が 2 つあります。release は、固定された各リリースがアプリケーションの latest_ready_release に対してどの状態にあるかを示します。latest、older、またはアプリケーションに latest_ready_release がない間は unknown です。screens は、配置のプレイリストのいずれかを、既定にしている、スケジュールしている、テイクオーバーに使っている、または現在表示している pairing_pending と active のスクリーンで、新しい順です。アーカイブ済みのスクリーンは数えません。Player がウェブアプリを表示できないスクリーンには applications_unsupported が付きます。

スクリーン(screen_scope)に限定されたメンバーまたはエージェントには、そのスクリーンだけが表示され、screen_count もそれらのスクリーンだけを数えます。これは削除を妨げる要因ではありません。削除を妨げるのはランタイム権限(スクリーンのマニフェストがリリースを保持していること)です。プロジェクトに存在しない ID は、getApplication と同様に not_found です。応答は private かつ no-store です。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardApplicationUsage

パラメーター

名前送信する必須?説明
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/applications/RESOURCE_ID/usage'

レスポンス

ステータス意味本文とヘッダー
200アプリケーションが配置されている場所。ApplicationUsage(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/advertising/inventory/{screen_id}

ダッシュボード広告在庫をPUT

認証
dashboardSession
リクエスト本文
AdvertisingInventoryWrite
操作ID
putDashboardAdvertisingInventory

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
screen_idパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。

リクエスト本文フィールド

フィールド説明
impressions_per_hour (任意、インライン)

この画面が 1 時間に届けるインプレッション数についての販売者の推定値。再生が完了するたびに、この値に再生秒数を掛けて 3600 で割った値が、レポートの推定インプレッションとして加算されます。null または省略は推定値なしを意味します。

ads_enabled(必須、ブール値)
site_name(任意、文字列)maxLength:120
city(任意、文字列)maxLength:120
地域(任意、文字列)maxLength:120
venue_type(任意、文字列)maxLength: 64
audience_tags(任意、配列)
配置(任意、文字列)maxLength:120
public_description(任意、文字列)maxLength: 500
rate_override_mcr_per_15s(任意、インライン)nullはプロジェクトのデフォルトからの継承を復元し、ゼロを意味しません。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/inventory/SCREEN_ID'

レスポンス

ステータス意味本文とヘッダー
200保存された在庫。AdvertisingInventory(application/json)
403OutsideScreenScope の場合と同じ outside_screen_scope。または approver_required - レビューを承認できない、スクリーンに限定されたメンバーは、スクリーンが何をいつ再生するかを変更できません(docs/screen-scope.md)。問題 (application/problem+json)
409

protected_target - 変更が保護されたスクリーンフォルダー内のスクリーンに及び、レビューの形式がありません(docs/screen-scope.md)。レビューを通じてフォルダーの保護を解除し、変更を行い、フォルダーを再度保護してください。

問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/media/{id}/usage

ダッシュボードメディア使用状況を取得

セッションのプロジェクトの準備完了メディア項目が使用されている場所。プロジェクトのプレイリストを 1 回走査し、それらを保持するスクリーンを 1 回読み取って計算されます。playlists は、まずファイルを名前で指定しているもの(画像または動画プリミティブの静的 ID と、id または ids によるセレクター、ストリームのフォールバック、カードの params 内の media:<id> 文字列、スティンガーのロゴ、サウンドトラックのトラック)、次にタグ、フォルダー、all セレクターがそのファイルに該当するものの順で、各グループ内はプレイリスト一覧の順序です。プレイリストは 1 つのエントリーで、その uses に各方法が一覧され、ファイルを直接指定する種類が先に並びます。

セレクターは、ランタイムが解決するとおりに判定されます。タグフィルターはファイルの tag と tags に一致し、フォルダーセレクターはフォルダー直下のファイル、all セレクターはその種類のすべてのファイルに一致します。保留中のファイルは、最後に承認されたタグとフォルダーで判定されます(一度も承認されていないファイルは、どのセレクターにも該当しません)。

ローテーション(batch_size、one_at_a_time)、利用可能時間帯、アスペクト調整、ページの可視性は判定されません。screens は、それらのプレイリストのいずれかを、既定にしている、スケジュールしている、テイクオーバーに使っている、または現在表示している pairing_pending と active のスクリーンで、新しい順です。アーカイブ済みのスクリーンは数えません。

スクリーン(screen_scope)に限定されたメンバーまたはエージェントには、そのスクリーンだけが表示され、screen_count もそれらのスクリーンだけを数えます。プロジェクトに存在しない ID や、準備完了になっていないメディア項目は、getMedia と同様に not_found です。応答は private かつ no-store です。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardMediaUsage

パラメーター

名前送信する必須?説明
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/media/RESOURCE_ID/usage'

レスポンス

ステータス意味本文とヘッダー
200メディアが使用されている場所。MediaUsage(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/media/{id}/thumbnail

ダッシュボードメディアサムネイルを取得

セッションのプロジェクトが所有する準備済み画像の小さなロスのあるWebPを返します。ダッシュボードのグリッドは元画像をデコードしません。サイズは1つで、縦横比を保持し512×512内に収まり、拡大されません。アニメーション画像は最初のフレームを表示します。

最初のリクエストで生成し元の横に保存します。後のリクエストは保存されたコピーをストリームし、メディア削除で元と共に削除されます。別プロジェクトの識別子、ビデオ、オーディオ、準備できていないメディアはnot_foundを返します。Rangeは受け付けません。

ETag は強力で、オリジナルとサムネイル生成元を示すため、すべてのリクエストとホストで同じです。レスポンスはプライベートで no-cache、If-None-Match が一致し、メディアがセッションのプロジェクトで解決された後にチェックされ、サムネイルを読み込まずに 304 を返します。完了したバイト数は dashboard_media の送信として記録されます。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardMediaThumbnail

パラメーター

名前送信する必須?説明
IDパス必須
If-None-Matchヘッダーオプションこのルートが返すサムネイル ETag。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/media/RESOURCE_ID/thumbnail'

レスポンス

ステータス意味本文とヘッダー
200WebP サムネイル。string (image/webp); ヘッダー: Content-Length, Content-Disposition, ETag, Cache-Control, X-Content-Type-Options
304サムネイルのETagがIf-None-Matchと一致します。ボディも送信も増加しません。本文なし;ヘッダー:ETag、Cache-Control
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)
HEAD/api/media/{id}/thumbnail

ダッシュボードメディアサムネイル

getDashboardMediaThumbnail と同じ所有権、条件、生成ルールを適用し、本文なしでヘッダーを返します。エグレスは記録されません。

認証
dashboardSession
リクエスト本文
なし
操作ID
headDashboardMediaThumbnail

パラメーター

名前送信する必須?説明
IDパス必須
If-None-Matchヘッダーオプションこのルートが返すサムネイル ETag。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request HEAD --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/media/RESOURCE_ID/thumbnail'

レスポンス

ステータス意味本文とヘッダー
200本文のないサムネイルメタデータです。本文なし;ヘッダー:Content-Length、Content-Disposition、ETag、Cache-Control、X-Content-Type-Options
304サムネイルのETagがIf-None-Matchと一致します。送信増加はありません。本文なし;ヘッダー:ETag、Cache-Control
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)
GET/api/email/verify

ダッシュボードのメール確認を覗く

スキャナー安全な検証ピーク。アドレスを検証せず、ユーザーを変更せず、訪問者をサインインさせません。リンクの目的と状態を報告します。保留中の account_email リンクは、ユーザーのダッシュボードセッションを伴うリクエストでのみ検証されるため、ページは確認を求める前にサインインを求めます。

認証
なし
リクエスト本文
なし
操作ID
peekDashboardEmailVerification

パラメーター

名前送信する必須?説明
トークンクエリ必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET 'https://screenrig.ai/api/email/verify?token=TOKEN'

レスポンス

ステータス意味本文とヘッダー
200検証ステータス。メール認証結果(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/email/verify

ダッシュボードメールを検証

明示的な人間の確認は、目的限定の検証チャレンジを1つ消費します。リンクサインアップのチャレンジには対応する __Host-screenrig-signup クッキーが必要です。メール変更のチャレンジはトークンに紐づくため、リンクはどのブラウザーでも動作します。

account_email チャレンジ(セルフサービスサインアップ時と POST /api/me/email/verification でメール送信され、30日間有効)は、どのブラウザーでも開けますが、リンクの宛先のユーザーの有効なダッシュボードセッションを伴うリクエストでのみ検証されます。email_verification_required によってこのルートのみに制限されたセッションも含まれます。

セッションがない場合、または別のユーザーのセッションの場合は、200 sign_in_required を返し、何も検証せず、リンクは使用可能なまま残ります。検証された account_email リンクは、ユーザーのアドレスを検証済みにして検証期限を終了します。別のユーザーが先に同じアドレスを検証していた場合は superseded を返します。検証によって訪問者がサインインすることはありません。

認証
なし または invitationSignup または dashboardSession
リクエスト本文
メール認証リクエスト
操作ID
verifyDashboardEmail

リクエスト本文フィールド

フィールド説明
トークン(必須、文字列)minLength: 1
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/email/verify'

レスポンス

ステータス意味本文とヘッダー
200検証ステータス。メール認証結果(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/webauthn/assertions

ダッシュボードパスキー認証開始

ユーザー名なしの WebAuthn 認証セレモニーを1回開始し、navigator.credentials.get 用のリクエストオプションをそのまま返します。クッキーは不要で、allowCredentials リストは公開されないため、ルートは存在するユーザーや認証情報について何も明かしません。セレモニーは DashboardCeremonyTTL の5分で期限切れになります。

サーバーがダッシュボード開発認証を実行している場合、このルートはpasskeys_disabledを返します。

認証
なし
リクエスト本文
なし
操作ID
startDashboardPasskeyAssertion
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST 'https://screenrig.ai/api/webauthn/assertions'

レスポンス

ステータス意味本文とヘッダー
201このセレモニーに紐づくWebAuthnリクエストオプション。ダッシュボードパスキー認証(application/json);ヘッダー:Cache-Control、RateLimit-Policy、RateLimit
400

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
403

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/webauthn/assertions/complete

Dashboard Passkeyアサーションを完了

ユーザー名なしのアサーションを1つ検証し、検出可能な認証情報が識別するユーザーのダッシュボードセッションCookieを発行します。リクエストの認証にCookieは不要です。未知、期限切れ、既使用の儀式はpasskey_invalidを返し、検証できないアサーションや逆行する署名カウンターも同様です。

有効なセレモニーで、その認証情報の識別子が誰にも登録されていない場合(どのユーザーにも、その識別子を持つ保存済みの認証情報がない場合)は、代わりに 401 passkey_unknown を返します。この応答はこの 1 つの場合にのみ返されるため、クライアントはこの応答に限り、ブラウザーにその認証情報を忘れさせることができます(PublicKeyCredential.signalUnknownCredential)。他の応答では行わないでください。

認証情報の識別子だけでは認可になりません。認可になるのは署名付きアサーションです。検証済みアドレスが、組織がシングルサインオンを必須としているドメインのものであるユーザーは、その組織のブレークグラス管理者でない限り、403 sso_required で拒否されます。そのブレークグラス管理者のサインインは監査されます。

サーバーがダッシュボード開発認証を実行している場合、このルートはpasskeys_disabledを返します。

認証
なし
リクエスト本文
ダッシュボードパスキー認証完了
操作ID
completeDashboardPasskeyAssertion

リクエスト本文フィールド

フィールド説明
ceremony_id(必須、文字列)
credential(必須、オブジェクト)認証器が返したPublicKeyCredentialからシリアライズされたWebAuthnアサーションレスポンス。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/webauthn/assertions/complete'

レスポンス

ステータス意味本文とヘッダー
200検証済みアサーションから発行されたセッションCookie。ダッシュボードセッション(application/json);ヘッダー:Cache-Control、Set-Cookie
400

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
401

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
403

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/sessions

ダッシュボードセッションを作成

検証済みのメールアドレスとパスワードで特定されたユーザーをサインインさせます。不明なメールアドレス、パスワードなし、誤ったパスワードは、いずれも同じ unauthorized 応答を返します。最後に使用したプロジェクトにメンバーシップが残っていればそれを開き、なければ最新のメンバーシップのプロジェクトを開きます。メンバーシップがない場合はプロジェクトなしです。

組織がシングルサインオンを必須としているドメインのアドレスは、アカウントを検索する前に 403 sso_required で拒否されるため、応答はそのアドレスを保持するユーザーがいるかどうかに依存しません。POST /api/sso/starts は、そのユーザーを ID プロバイダー経由でサインインさせます。

パスワードでのサインインには検証済みのメールが必要です。そのため、自分でサインアップしたユーザー(POST /api/signups)はパスキーでサインインし、未検証のアドレスにパスワードを設定したユーザーも unauthorized の応答を受け取ります。開発認証も同じパスワードフローを使用します。

認証
なし
リクエスト本文
ダッシュボードパスワードログイン
操作ID
createDashboardSession

リクエスト本文フィールド

フィールド説明
email(必須、文字列)その人の検証済みメールアドレス。不明なメール、パスワードなし、誤ったパスワードはすべて同じ認証失敗応答を返します。minLength: 3 maxLength: 254 format: "email"
パスワード(必須、文字列)minLength: 12 maxLength: 128
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/sessions'

レスポンス

ステータス意味本文とヘッダー
200検証済みメールとパスワードから発行された人物セッション。ダッシュボードセッション(application/json);ヘッダー:Cache-Control、Set-Cookie、RateLimit-Policy、RateLimit
400

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
401

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
403

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
500

安定した 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)
GET/api/session

ダッシュボードセッションを取得

現在のダッシュボードセッションを返します。セッションCookieとサーバー側セッションが権限を確立し、user_idは説明的です。401レスポンスはサインインが必要なことを意味します。

dev_auth フィールドはローカル開発用に予約されており、ホストサービスでは false です。organization はユーザーのホーム組織で、ホーム組織がない間は含まれません。project.organization_admin は、ユーザーが現在のプロジェクトの組織を管理していることを示します。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardSession
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/session'

レスポンス

ステータス意味本文とヘッダー
200現在のダッシュボードセッション。ダッシュボードセッション(application/json);ヘッダー:Cache-Control
401

安定した 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)
POST/api/logout

ダッシュボードセッションをログアウト

サーバー側のセッション行を削除し、セッションCookieを期限切れにします。ユーザーや認証情報は削除されません。これは本質的に冪等であり、Idempotency-Keyは不要です。

成功したサインアウトはブラウザのダッシュボードオリジンのHTTPキャッシュもクリアし、セッションが閲覧したプライベートでノーキャッシュのメディア、スクリーンショット、広告レビューのバイトを削除します。期限切れのみのセッションはブラウザが削除するまで保持します。

認証
dashboardSession
リクエスト本文
なし
操作ID
logoutDashboardSession
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/logout'

レスポンス

ステータス意味本文とヘッダー
204セッション行が削除され、セッションCookieが期限切れとなり、このオリジンのブラウザHTTPキャッシュがクリアされました。本文なし;ヘッダー:Cache-Control、Set-Cookie、Clear-Site-Data
401

安定した 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)
POST/api/onboarding/steps

オンボーディングステップを記録

1 つのブラウザーによるダッシュボードのエントリーフロー(サインアップ、サインイン、リセット、招待、パスキーの追加)の実行について、1 つのステップを報告します。スタッフ向けのオンボーディング読み取りに使われます。公開エンドポイントで、ダッシュボードのセッションの有無にかかわらず動作します。

ジャーニーはブラウザー自身のランダムな ID です。リクエストがエッジの訪問者クッキーを持つ場合はそのクッキー、セッションを持つ場合はそのユーザーと組織も、サーバーが保持します。ジャーニーはスタッフ専用で、ユーザーが入力した実際の値(アドレス、名前、回答)を保持しますが、パスワード、コード、トークンは決して受け取りません。

mode、source、utm_source、utm_medium、utm_campaign、click_kind、site_trail、site_cta は最初の値が保持されます。各ステップは最初の時刻を保持し、ステップの value、detail、およびジャーニーの email(email_submitted から取得)は最新の値になります。source は entry_viewed でのみ受け付けられます。question は question_* ステップでは必須で、それ以外のステップでは拒否されます。detail は、*_failed ステップでは問題コード、signed_in ではサインイン方法、signup_finished では connected または skipped です。email_verified、email_gate_reached、site_visited、site_cta_clicked、およびアカウントのマイルストーンは、サーバーが書き込むか導出するもので、ここでは拒否されます。

長さのみが制限されます。クライアントアドレスごとに制限されます。

認証
なし
リクエスト本文
OnboardingStepRequest
操作ID
recordOnboardingStep

リクエスト本文フィールド

フィールド説明
journey_id(必須、文字列)ブラウザーのジャーニー:ダッシュボードが自身のストレージに保持する、小文字の RFC 4122 UUID。pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
step(必須、OnboardingStepName)

エントリーフローのステップ。表示順に並んでいます。email_verified、email_gate_reached、およびアカウントのマイルストーン(agent_connected、screen_paired、playlist_with_content、activated)は、サーバーが書き込むか結合するもので、クライアントが送信する名前ではありません。

許可:"entry_viewed"、"returning_shown"、"email_submitted"、"address_new"、"address_existing"、"address_sso"、"address_failed"、"signup_form_viewed"、"signup_name_entered"、"signup_marketing_choice"、"passkey_unsupported"、"passkey_started"、"passkey_cancelled"、"signup_failed"、"account_created"、"question_shown"、"question_answered"、"question_follow_up"、"question_skipped"、"connect_viewed"、"connect_copied"、"agent_approved"、"signup_finished"、"dashboard_opened"、"signin_passkey_started"、"signin_passkey_cancelled"、"signin_password_started"、"signin_sso_started"、"signin_failed"、"signed_in"、"reset_viewed"、"reset_requested"、"reset_opened"、"reset_completed"、"invite_viewed"、"invite_email_sent"、"invite_passkey_started"、"invite_passkey_cancelled"、"invite_failed"、"invite_accepted"、"passkey_upgrade_shown"、"passkey_add_started"、"passkey_add_cancelled"、"passkey_added"

mode(任意、文字列)エントリーページのモード。最初の値が保持されます。許可:"login"、"signup"
source(任意、文字列)

entry_viewed と併用する場合のみ指定できます。ユーザーの流入元を、エントリーページが示す形で表します。サインアップリンクのパス、最後に閲覧したウェブサイトのページ、参照元ホスト、または direct のいずれかです。送信されたまま保持されます。最初の値が保持されます。maxLength: 500

utm_source(任意、文字列)小文字に変換されます。最初の値が保持されます。maxLength: 80
utm_medium(任意、文字列)小文字に変換されます。最初の値が保持されます。maxLength: 80
utm_campaign(任意、文字列)小文字に変換されます。最初の値が保持されます。maxLength: 80
click_kind(任意、文字列)ランディングページが持っていた広告クリック ID の種類。ID 自体は送信されません。許可:"gclid"、"gbraid"、"wbraid"、"fbclid"、"msclkid"、"li_fat_id"、"ttclid"、"rdt_cid"、"twclid"
question(任意、文字列)

question_shown、question_answered、question_follow_up、question_skipped では必須で、それ以外のすべてのステップでは拒否されます。agent_other、heard_text、heard_kind はフォローアップを表し、question_follow_up でのみ指定します。

許可:"who_for"、"use_case"、"screen_range"、"go_live"、"devices"、"role"、"firm_kind"、"agent"、"heard"、"agent_other"、"heard_text"、"heard_kind"

detail(任意、文字列)*_failed ステップでは問題コード、signed_in ではサインイン方法(passkey、password、sso、autofill)、signup_finished では connected または skipped です。送信されたまま保持されます。maxLength: 200
value(任意、OnboardingValue)

ステップでユーザーが入力した内容:入力されたアドレス(email_submitted、reset_requested)、名前(signup_name_entered)、はいまたはいいえ(signup_marketing_choice)、選択されたオプションまたはフォローアップのテキスト(question_answered、question_follow_up)、招待で入力されたアドレスまたは名前。パスワード、コード、トークンは決して含まれません。空の値は存在しないものとして扱われます。

site_trail(任意、配列)このタブでブラウザーがウェブサイト上で閲覧したページ(古い順)。最初の値が保持されます。
site_cta(任意、OnboardingSiteCTA)ユーザーがウェブサイトでクリックしたサインアップまたはサインインのリンク。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/onboarding/steps'

レスポンス

ステータス意味本文とヘッダー
204ステップを記録しました。本文なし;ヘッダー:Cache-Control、RateLimit-Policy、RateLimit
400

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/agents

ダッシュボードエージェント一覧

セッションプロジェクトのすべての保留中、有効、無効、キャンセル済み、期限切れエージェントを安全なインストールメタデータ、最終使用、認証リクエスト数、直接帰属可能な計測クレジット付きで一覧表示。ベアラー、受信者キー、エンベロープ、プロジェクト識別子は返さない。

認証
dashboardSession
リクエスト本文
なし
操作ID
listDashboardAgents
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agents'

レスポンス

ステータス意味本文とヘッダー
200プロジェクトエージェント。AgentList(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/agents/{id}/events

ダッシュボードエージェントイベント一覧

このエージェントの履歴は最新が先頭で、トリガーごとに1件の記録です。エージェントが要求した内容と結果として変わった内容の両方を含みます。何かを変更したリクエストは、その原因となったコマンドでスタンプされたドメインイベントです。何も変更しなかったリクエスト(拒否、失敗、イベントなしの成功)は1つの agent.command イベントです。

別のコマンドエンドポイントはありません。同じトリガーを2つのパネルに表示するのがこの欠陥の置き換えです。このエージェントのライフサイクルイベントは含まれます。ワーカー、プレーヤー、ダッシュボード専用のアクティビティはエージェントアクティビティとは推測されません。2つのリクエストは2つのトリガーです。拒否後の再試行は2つ目のレコードであり、最初の書き換えではありません。

読み取りは記録されません。何も変更せず、ポーリングエージェントはすべての実際の操作を埋もれさせるためです。匿名登録は除外されます。コマンドスタンプのすべての部分はこのサーバーが一致したルートまたは問題レジストリから派生します。

引数ベクターもリクエストボディもヘッダーもレコード内に自由テキストもなく、編集不要で、呼び出し元がオペレーターが見える画面に任意のテキストを書き込むことはできません。リソース識別子は認可ではなくイベントで既に公開されています。ページングキーはシーケンスの降順です。

続行するには返されたnext_cursorをafterとして渡してください。ページが短い場合、next_cursorは空で履歴の終わりを示します:同時追加はより高いシーケンスを取り、保持は最も低いシーケンスを先に削除するため、カーソルは生存レコードを重複またはスキップしません。オフセットページングはサポートされていません。

すべての検索パラメータはサーバー生成トークンに対する完全一致または範囲述語です。不正なカーソルやフィルター値はinvalid_requestで拒否されます。1-200の範囲外の制限は拒否されずデフォルトに調整されます。レコードはプロジェクト独自のイベント保持期間で期限切れになります。

認証
dashboardSession
リクエスト本文
なし
操作ID
listDashboardAgentEvents

パラメーター

名前送信する必須?説明
IDパス必須
以降クエリオプション前のページのnext_cursorからのカーソル。
制限クエリオプション
コマンドクエリオプションscreens.archive のような正確なルート派生コマンド名。
タイプクエリオプションagent.commandやscreen.archivedのような正確なイベントタイプ。
resource_typeクエリオプションリクエストが作用したオブジェクトの正確な種類。
resource_idクエリオプションリクエストが作用したオブジェクトの正確な識別子。
結果クエリオプションagent.commandレコードにのみ存在します。ドメインイベントはokを意味します。
problem_codeクエリオプションサーバーが拒否した正確な安定問題コード。
以降クエリオプション
までクエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agents/RESOURCE_ID/events'

レスポンス

ステータス意味本文とヘッダー
200エージェント履歴。EventList (application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/agents/{id}/disconnect

ダッシュボードエージェントを切断

新しい証明後に、選択したプロジェクトからエージェントを切断します。プロジェクトは、その人のメンバーシップのいずれかである必要があります。保留中の接続と資格情報の発行はキャンセルされ、代わりのトークンは発行されません。スクリーンに限定されたメンバーは、エージェントの接続、資格情報の発行、プロジェクトのユーザー管理を行えません:outside_screen_scope(プロジェクトオーナーに依頼してください)。

認証
dashboardSession
リクエスト本文
ダッシュボードエージェントアクション
操作ID
disconnectDashboardAgent

パラメーター

名前送信する必須?説明
IDパス必須

リクエスト本文フィールド

フィールド説明
project_id(必須、文字列)minLength: 1
proof(任意、DashboardProof)
機能(任意、配列)

オプションのエージェント接続および接続済みアプリ承認のみ。省略は要求されたセット全体を承認します。接続の機能の非空部分集合は付与された資格情報を狭めます。それ以外はinvalid_requestです。

user_code(任意、文字列)

デバイスサインイン(フローデバイス)を承認する際に必要です:本人が確認するコードが端末と一致すること。不一致はagent_connection_code_mismatchです。5回目はサインインの有効期限切れ(agent_connection_expired)です。それ以外は無視されます。maxLength:32

アクセス(任意、文字列)

デバイスのサインインまたは接続されたアプリの承認されたアクセスレベル(読み取り専用、提案、管理)。省略時は要求されたレベルを維持。他の接続では無視。レビューを承認できない人は管理を承認できません(403 approver_required)。許可される値:「read」「propose」「manage」

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/agents/RESOURCE_ID/disconnect'

レスポンス

ステータス意味本文とヘッダー
204エージェントが切断されました。本文なし
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)
GET/api/agents/{id}/notes

ダッシュボードエージェントメモ一覧

このエージェントがセッションプロジェクトで書いたノート、最新順、未解決と解決済み。stateはall(デフォルト)、open、resolved。next_cursorをafterとして返します;最後のページでは空です。ノート本文はエージェントが書いたプレーンテキストで、テキストとしてレンダーし、HTMLやMarkdownではありません。

認証
dashboardSession
リクエスト本文
なし
操作ID
listDashboardAgentNotes

パラメーター

名前送信する必須?説明
IDパス必須
状態クエリオプション
以降クエリオプション前のページの next_cursor。
制限クエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agents/RESOURCE_ID/notes'

レスポンス

ステータス意味本文とヘッダー
200エージェントのメモ。NotePage(application/json);ヘッダー:Cache-Control
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)
POST/api/agents/{id}/notes/{note_id}/resolve

ダッシュボードエージェントメモを解決

サインインした人物としてエージェントのオープンノートの1つを理由付きで解決します。resolution.byに人物名を記録します。note.resolvedに人物をアクターとして追加します。解決済みノートはnote_not_openです。

認証
dashboardSession
リクエスト本文
NoteResolve
操作ID
resolveDashboardAgentNote

パラメーター

名前送信する必須?説明
IDパス必須
note_idパス必須エージェントのメモのIDの1つ。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

リクエスト本文フィールド

フィールド説明
理由(必須、文字列)minLength: 1 maxLength: 500
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/agents/RESOURCE_ID/notes/NOTE_ID/resolve'

レスポンス

ステータス意味本文とヘッダー
200解決済みのメモ。メモ(application/json)
404

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
409

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
422

安定した 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)
削除/api/agents/{id}/notes/{note_id}

ダッシュボードエージェントメモ削除

サインインしているユーザーとして、エージェントのメモ(未解決または解決済み)を1つ削除します。note.deletedにユーザーをアクターとして追加します。

認証
dashboardSession
リクエスト本文
なし
操作ID
deleteDashboardAgentNote

パラメーター

名前送信する必須?説明
IDパス必須
note_idパス必須エージェントのメモのIDの1つ。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agents/RESOURCE_ID/notes/NOTE_ID'

レスポンス

ステータス意味本文とヘッダー
204削除されました。本文なし
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)
GET/api/agent-connections/pending

ダッシュボードエージェント接続一覧

セッションプロジェクト宛ての保留中接続要求。メンバーがレビューし承認できます:プロジェクト名の要求と、すでにメンバーであるエージェントIDによるデバイスサインインまたは接続。

新しいインストールのサインインはリストされません(プロジェクトヒントはクライアント提供です)。ユーザーコードでアクセスできます(POST /api/agent-connections/lookup)。

認証
dashboardSession
リクエスト本文
なし
操作ID
listDashboardAgentConnections
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agent-connections/pending'

レスポンス

ステータス意味本文とヘッダー
200保留中の要求、最新が最初、最大100件。オブジェクト(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/agent-connections/lookup

ダッシュボードエージェント接続を検索

保留中のデバイスサインインのユーザーコード(`screenrig login`)を、接続ページで入力または自動入力されたまま解決し、その接続の承認ビューを表示します。何も承認しません。区切り文字、空白、大文字小文字は無視されます。不明、使用済み、無効なコードはagent_connection_invalid、期限切れはagent_connection_expiredです。

ダッシュボードセッションごとに10分あたり5回、クライアントアドレスごとに1時間あたり20回、フリート全体で1時間あたり1200回の照会に制限されます(rate_limited)。スクリーンに限定されたメンバーは、エージェントの接続、資格情報の発行、プロジェクトのユーザー管理を行えません:outside_screen_scope(プロジェクトオーナーに依頼してください)。

認証
dashboardSession
リクエスト本文
object
操作ID
lookupDashboardAgentConnection

リクエスト本文フィールド

フィールド説明
user_code(必須、文字列)maxLength: 32
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/agent-connections/lookup'

レスポンス

ステータス意味本文とヘッダー
200コードが名前付けする接続です。オブジェクト(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)
GET/api/agent-connections/{id}

ダッシュボードエージェント接続を取得

安全な接続のレビューのメタデータを返します。レビューはプロジェクトを選択せず、承認はその人のメンバーシップのいずれかを選択します。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardAgentConnection

パラメーター

名前送信する必須?説明
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agent-connections/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200安全な接続メタデータ。AgentConnection(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/agent-connections/{id}/approve

ダッシュボードエージェント接続を承認

新しい証明後に、選択したプロジェクトへの接続を承認し、保留中のエージェントを作成します。プロジェクトは、その人のメンバーシップのいずれかである必要があります。安全なメタデータを返し、ベアラーは返しません。スクリーンに限定されたメンバーは、エージェントの接続、資格情報の発行、プロジェクトのユーザー管理を行えません:outside_screen_scope(プロジェクトオーナーに依頼してください)。

認証
dashboardSession
リクエスト本文
ダッシュボードエージェントアクション
操作ID
approveDashboardAgentConnection

パラメーター

名前送信する必須?説明
IDパス必須

リクエスト本文フィールド

フィールド説明
project_id(必須、文字列)minLength: 1
proof(任意、DashboardProof)
機能(任意、配列)

オプションのエージェント接続および接続済みアプリ承認のみ。省略は要求されたセット全体を承認します。接続の機能の非空部分集合は付与された資格情報を狭めます。それ以外はinvalid_requestです。

user_code(任意、文字列)

デバイスサインイン(フローデバイス)を承認する際に必要です:本人が確認するコードが端末と一致すること。不一致はagent_connection_code_mismatchです。5回目はサインインの有効期限切れ(agent_connection_expired)です。それ以外は無視されます。maxLength:32

アクセス(任意、文字列)

デバイスのサインインまたは接続されたアプリの承認されたアクセスレベル(読み取り専用、提案、管理)。省略時は要求されたレベルを維持。他の接続では無視。レビューを承認できない人は管理を承認できません(403 approver_required)。許可される値:「read」「propose」「manage」

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/agent-connections/RESOURCE_ID/approve'

レスポンス

ステータス意味本文とヘッダー
200保留中のエージェント安全メタデータ。Agent(application/json)
409

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (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)
POST/api/agent-connections/{id}/deny

ダッシュボードエージェント接続を拒否

新しい証明後に、エージェントを作成せずに、選択したプロジェクトへの接続を拒否します。プロジェクトは、その人のメンバーシップのいずれかである必要があります。スクリーンに限定されたメンバーは、エージェントの接続、資格情報の発行、プロジェクトのユーザー管理を行えません:outside_screen_scope(プロジェクトオーナーに依頼してください)。

認証
dashboardSession
リクエスト本文
ダッシュボードエージェントアクション
操作ID
denyDashboardAgentConnection

パラメーター

名前送信する必須?説明
IDパス必須

リクエスト本文フィールド

フィールド説明
project_id(必須、文字列)minLength: 1
proof(任意、DashboardProof)
機能(任意、配列)

オプションのエージェント接続および接続済みアプリ承認のみ。省略は要求されたセット全体を承認します。接続の機能の非空部分集合は付与された資格情報を狭めます。それ以外はinvalid_requestです。

user_code(任意、文字列)

デバイスサインイン(フローデバイス)を承認する際に必要です:本人が確認するコードが端末と一致すること。不一致はagent_connection_code_mismatchです。5回目はサインインの有効期限切れ(agent_connection_expired)です。それ以外は無視されます。maxLength:32

アクセス(任意、文字列)

デバイスのサインインまたは接続されたアプリの承認されたアクセスレベル(読み取り専用、提案、管理)。省略時は要求されたレベルを維持。他の接続では無視。レビューを承認できない人は管理を承認できません(403 approver_required)。許可される値:「read」「propose」「manage」

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/agent-connections/RESOURCE_ID/deny'

レスポンス

ステータス意味本文とヘッダー
204接続が拒否されました。本文なし
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)
GET/api/dashboard/boot

ダッシュボード起動データを取得

ダッシュボードシェル用の 1 回のリクエスト。

各メンバーは、対応するルートがこの同じセッションに対して返すボディです(GET /api/me/email、/api/support/status、/api/projects、/api/organizations、/api/project、/api/project/capabilities、/api/advertising/network、/api/alerts?state=open&limit=1、/api/reviews?state=all&limit=1)。そのルート自身のハンドラーが、そのルート自身の認可、プラン、スコープのチェックの下で生成します。

メンバーは、そのルートがこのセッションに対して 2xx で応答しない場合(拒否、読み取れないロールまたはプラン、現在のプロジェクトがない場合、障害)は含まれず、その場合はダッシュボードがそのルートを自分で読み取ります。advertising_network は、プロジェクトにネットワークがないためそのルートが 404 not_found で応答する場合は null です。

現在のプロジェクトがないセッションには、プロジェクトを必要としないメンバーが返されます。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardBoot
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/dashboard/boot'

レスポンス

ステータス意味本文とヘッダー
200ダッシュボードシェルの読み取り。DashboardBoot(application/json);ヘッダー:Cache-Control
401

安定した 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)
GET/api/summary

ダッシュボード概要を取得

セッションのプロジェクトにおけるプロジェクトのネットワークステータスカウンター。スクリーンのオンライン数はライブのペアリングされたランタイムイベントストリームから算出され、Screen.onlineが公開するものと同じです。これは保存されたブール値やプレーヤーハートビートではありません。メディアバイトは準備済みメディアの耐久バイトのみです。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardSummary
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/summary'

レスポンス

ステータス意味本文とヘッダー
200プロジェクトの概要カウンター。ダッシュボードサマリー(application/json);ヘッダー:Cache-Control
401

安定した 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)
GET/api/billing/payout-status

ダッシュボード支払い状況を取得

正確な支払い能力状態。rails_availableがfalseでunavailable_reasonがfinancial_rails_unavailableの場合、カード、税金、現金引き出しのレールは利用不可。生の銀行認証情報は返されません。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardPayoutStatus
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/billing/payout-status'

レスポンス

ステータス意味本文とヘッダー
200支払い状況。BillingPayoutStatus(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/billing/receipts/{id}

ダッシュボード領収書を取得

呼び出し元が所有する1つの確定済み領収書/税務書類。未発送の資金回収中は領収書が存在しないため、これはnot_foundであり、偽造書類ではありません。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardReceipt

パラメーター

名前送信する必須?説明
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/billing/receipts/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
404not_found - レシートが存在しません。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/balance

ダッシュボード残高を取得

セッションプロジェクトの公開全クレジット残高を返します。このクッキー認証読み取りは決してデビットしないため、ゼロでも利用可能です。クッキーのみのダッシュボードはプロジェクトベアラーをGET /api/projectに提示しません。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardBalance
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/balance'

レスポンス

ステータス意味本文とヘッダー
200公開済みの全クレジット残高。ダッシュボード残高(application/json);ヘッダー:Cache-Control
401

安定した 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)
POST/api/applications/{id}/preview-launches

ダッシュボードアプリプレビューローンチを作成

セッションのプロジェクトが所有するアプリケーションの最新の準備完了リリースに対し、そのリリースの正確なプレビューホストで使い捨て30秒起動チケットを1つ発行します。リリースホストの Players フレームではなく、1つのブラウザで Player とダッシュボードが同じホストのキャッシュドキュメントやクッキーを共有しません。

チケットはそのホスト上でのみ release-grant クッキーに変換されるため、プレビューは構造上クロスオリジンであり、ウェブアプリコードはダッシュボードクッキーを読み取れません。レスポンスの release_id は、後から別の公開が完了しても、この起動で選択された正確なリリースを示します。launch_url は iframe.src に割り当て、他には割り当てないでください。

ここでの権限はオーナー権限です:セッションのプロジェクトがアプリケーションを所有します。これはscreenrig.webapp-package/v1の正確な現在のマニフェスト権限と並ぶ意図的な二次権限ソースで、この操作に限定されています。メディアや保護されたランタイムコンテンツには一般化しないでください。

親Playerはなく、ブラウザSDKとキー・バリューブリッジは閉じて失敗し、プレビューはプレゼンテーションのみです。準備済みのリリースがないアプリケーションは resource_conflict になります。

認証
dashboardSession
リクエスト本文
なし
操作ID
createDashboardApplicationPreviewLaunch

パラメーター

名前送信する必須?説明
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/applications/RESOURCE_ID/preview-launches'

レスポンス

ステータス意味本文とヘッダー
201使い切り30秒のexact-release-hostプレビュ起動。DashboardApplicationPreviewLaunch (application/json); ヘッダー: Cache-Control, Referrer-Policy, RateLimit-Policy, RateLimit
401

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (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)
409

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/organizations/{org_id}

ダッシュボード組織を取得

GET /api/organizations の項目として呼び出し元に表示されるとおりの組織1件で、admin、home、reseller を含みます。サインイン済みのユーザーは、その組織を管理している場合、委任先のリセラーを管理している場合、スタッフである場合、またはその一覧に表示される場合(有効なプロジェクトのメンバーである場合、またはホーム組織である場合)に読み取れます。

それ以外の人、および存在しない組織には 404 not_found が返ります。プロジェクトメンバーシップは付与しません。対象は Cookie セッションのみで、エージェント認証情報は拒否されます。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardOrganization

パラメーター

名前送信する必須?説明
org_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/organizations/ORG_ID'

レスポンス

ステータス意味本文とヘッダー
200組織の結果。OrganizationView(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/organizations/{org_id}/projects

ダッシュボード 組織 プロジェクト

組織管理者が読み取れるのは、プロジェクト名、オーナー、ステータス、スクリーン数のみです。これによりプロジェクトアクセスは付与されません。管理者がプロジェクトのコンテンツを読み取れるのは、プロジェクトに参加した後(POST .../projects/{project_id}/access)のみで、そのユーザーの管理は以下のオーナーとメンバーのルートで行います。

認証
dashboardSession
リクエスト本文
なし
操作ID
dashboardOrganizationsProjects

パラメーター

名前送信する必須?説明
org_idパス必須
カーソルクエリオプション
制限クエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/projects'

レスポンス

ステータス意味本文とヘッダー
200組織の結果。OrganizationProjectPage(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/resellers

ダッシュボードリセラー一覧

サインイン済みのユーザーが組織を管理している有効なリセラーを、名前順に返します(admin_user_ids)。それ以外のユーザーには空になります。対象は Cookie セッションのみです。リセラーとは、スタッフがリセラーに設定した組織、またはその管理者が登録した組織です(POST /api/resellers)。その管理者が顧客の組織を運用します(docs/resellers.md)。

認証
dashboardSession
リクエスト本文
なし
操作ID
listDashboardResellers
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers'

レスポンス

ステータス意味本文とヘッダー
200呼び出し元のリセラー。ResellerList(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/resellers

リセラーを登録する

組織の管理者は、その組織を即座にリセラーにできます。呼び出し元は、メールアドレスが確認済みのサインイン済みユーザーで、organization_id で指定された組織の管理者である必要があります(Cookie セッションのみ。エージェントとサービスクライアントがリセラーの権限を持つことはありません)。それ以外の人には 404 not_found が返ります。

リセラーは定価の 2000 ベーシスポイント(20%)で今すぐ有効になり、審査待ちの状態から始まります。screenRIG が審査するまでは、現在の顧客を最大 10 社(customer_limit)まで登録できます。組織は有効で、すでにリセラーでなく、リセラーの顧客でもなく、スタッフまたはプロモのプランでもない必要があります(409 reseller_conflict、detail に理由が示されます)。

組織の監査に reseller.enrolled を追加します。

認証
dashboardSession
リクエスト本文
ResellerEnrollment
操作ID
enrollReseller

リクエスト本文フィールド

フィールド説明
organization_id(必須、文字列)リセラーにする組織。呼び出し元はその管理者の 1 人である必要があります。minLength: 1 maxLength: 200
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/resellers'

レスポンス

ステータス意味本文とヘッダー
201新しいリセラー。GET /api/resellers/{reseller_id} が返すものと同じです。Reseller(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/resellers/{reseller_id}

ダッシュボードリセラーを取得

呼び出し元が管理するリセラー1件で、そのマージンを含みます。それ以外の人には 404 not_found が返ります。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardReseller

パラメーター

名前送信する必須?説明
reseller_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers/RESELLER_ID'

レスポンス

ステータス意味本文とヘッダー
200リセラー。Reseller(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/resellers/{reseller_id}/customers

ダッシュボードリセラー顧客一覧

リセラーの現在の顧客(委任されている組織)を名前順に、プラン、件数、保存バイト数とともに返します。対象はリセラー管理者のみで、それ以外の人には 404 not_found が返ります。

認証
dashboardSession
リクエスト本文
なし
操作ID
listDashboardResellerCustomers

パラメーター

名前送信する必須?説明
reseller_idパス必須
カーソルクエリオプション
制限クエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers/RESELLER_ID/customers'

レスポンス

ステータス意味本文とヘッダー
200顧客の1ページ分。ResellerCustomerPage(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/resellers/{reseller_id}/customers

ダッシュボードリセラー顧客を作成

作成時点からリセラーに委任された顧客組織を Standard プランで作成し、呼び出し元のリセラー管理者を唯一の管理者とします。呼び出し元のホーム組織は変わりません。組織自身の管理者は、後から委任を終了できます(DELETE /api/organizations/{org_id}/reseller)。

組織の監査に organization.created と reseller.customer_started を追加します。審査待ち(review_state pending)のリセラーは、現在の顧客を customer_limit 社まで登録できます。それを超えると 409 reseller_conflict が返ります。

認証
dashboardSession
リクエスト本文
object
操作ID
createDashboardResellerCustomer

パラメーター

名前送信する必須?説明
reseller_idパス必須

リクエスト本文フィールド

フィールド説明
name(必須、ProjectName)トリムされた印刷可能なプロジェクト名。制御文字、URLのようなテキスト、@、www.、://は拒否します。minLength:1 maxLength:60
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/resellers/RESELLER_ID/customers'

レスポンス

ステータス意味本文とヘッダー
201新しい顧客。ResellerCustomer(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/resellers/{reseller_id}/customers/{org_id}

ダッシュボードリセラー顧客を取得

リセラーの現在の顧客1件。対象はリセラー管理者のみです。現在の顧客でない組織には 404 not_found が返ります。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardResellerCustomer

パラメーター

名前送信する必須?説明
reseller_idパス必須
org_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers/RESELLER_ID/customers/ORG_ID'

レスポンス

ステータス意味本文とヘッダー
200顧客。ResellerCustomer(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/resellers/{reseller_id}/customers/{org_id}/plan

ダッシュボードリセラー顧客プランを設定

現在の顧客のプランを設定します。プランの料金はリセラーが支払います。standard はプランを削除し、plus と premium は常に指定でき、education は Education プランの対象となる組織にのみ指定できます。Enterprise、staff、promo はスタッフが割り当てます。

アップグレードは直ちに、ダウングレードまたは削除は次の UTC 月の境界で適用されます。組織のプラン変更と同じです(docs/billing-rollup.md)。組織の監査に reseller.customer_plan を追加します。

認証
dashboardSession
リクエスト本文
object
操作ID
setDashboardResellerCustomerPlan

パラメーター

名前送信する必須?説明
reseller_idパス必須
org_idパス必須

リクエスト本文フィールド

フィールド説明
plan_id(必須、文字列)許可:"standard"、"plus"、"education"、"premium"
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/resellers/RESELLER_ID/customers/ORG_ID/plan'

レスポンス

ステータス意味本文とヘッダー
200現在保存されているプランを含む顧客。ResellerCustomer(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/resellers/{reseller_id}/customers/{org_id}/projects

ダッシュボードリセラー顧客プロジェクト一覧

現在の顧客の有効なプロジェクトを、名前、ステータス、スクリーン数、呼び出し元がすでにメンバーかどうかとともに返します。一覧の取得ではプロジェクトへのアクセスは付与されません。POST .../access でプロジェクトに参加します。

認証
dashboardSession
リクエスト本文
なし
操作ID
listDashboardResellerCustomerProjects

パラメーター

名前送信する必須?説明
reseller_idパス必須
org_idパス必須
カーソルクエリオプション
制限クエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers/RESELLER_ID/customers/ORG_ID/projects'

レスポンス

ステータス意味本文とヘッダー
200プロジェクトの1ページ分。ResellerCustomerProjectPage(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/resellers/{reseller_id}/customers/{org_id}/projects/{project_id}/access

ダッシュボードリセラー顧客プロジェクトに参加

呼び出し元のリセラー管理者を、現在の顧客のプロジェクトのフルメンバーにします(can_approve、スコープなし、source は reseller_admin)。組織管理者の参加と同じ扱いで、PUT /api/session/project でプロジェクトを開けるようになります。すでにメンバーの場合は、プロジェクトをそのまま返します。

プロジェクトに member.added_by_reseller を、組織の監査に reseller.project_joined を追加し、プロジェクトオーナーにメールを送信します。メンバーシップは削除されるまで維持され、委任を終了しても削除されません。

認証
dashboardSession
リクエスト本文
なし
操作ID
joinDashboardResellerCustomerProject

パラメーター

名前送信する必須?説明
reseller_idパス必須
org_idパス必須
project_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers/RESELLER_ID/customers/ORG_ID/projects/PROJECT_ID/access'

レスポンス

ステータス意味本文とヘッダー
200呼び出し元が開けるようになったプロジェクト。DashboardProjectReference(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/resellers/{reseller_id}/statement

ダッシュボードリセラー明細を取得

リセラーが 1 つの UTC 月に支払う金額です。その月に一度でも委任されていた顧客ごとに 1 行で、月内の委任期間に発生した使用料のうち顧客自身のクレジットでまかなわれなかった分(定価とリセラー価格の両方)と、そのプランの年額が示されます。

リセラーの価格は、定価からマージンを差し引いた額です。マージンは、その月の開始とリセラーの(再)作成のうち遅い方の時点で有効なものが適用されます。対象はリセラー管理者のみです。

認証
dashboardSession
リクエスト本文
なし
操作ID
getDashboardResellerStatement

パラメーター

名前送信する必須?説明
reseller_idパス必須
期間クエリオプションUTC 月(YYYY-MM)。省略すると現在の月です。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/resellers/RESELLER_ID/statement'

レスポンス

ステータス意味本文とヘッダー
200明細。ResellerStatement(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/organizations/{org_id}/reseller

ダッシュボード組織のリセラー委任を終了

組織の管理者は、リセラーへの委任を直ちに終了します。以後、組織は自分で支払います。プラン、プロジェクト、メンバーはそのまま維持され、リセラー管理者が持つメンバーシップも含まれます。委任中に組織のウォレットで発生した超過分(リセラーに請求される分)は、同じ変更で帳消しになります。

組織の監査に reseller.customer_ended を追加します。リセラーのない組織には 404 not_found が返ります。

認証
dashboardSession
リクエスト本文
なし
操作ID
endDashboardOrganizationReseller

パラメーター

名前送信する必須?説明
org_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/reseller'

レスポンス

ステータス意味本文とヘッダー
200リセラーのなくなった組織。OrganizationView(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/organizations/{org_id}/discovery

ダッシュボード 組織 発見

所有者が正確に検証済みドメインのメールを持つ他の場所のプロジェクト。連絡先アドレスやサブドメインは一致せず、管理者はプロジェクトを引き込めません。

認証
dashboardSession
リクエスト本文
なし
操作ID
dashboardOrganizationsDiscovery

パラメーター

名前送信する必須?説明
org_idパス必須
カーソルクエリオプション
制限クエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/discovery'

レスポンス

ステータス意味本文とヘッダー
200組織の結果。OrganizationProjectPage(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/organizations/{org_id}/domain-challenges

ダッシュボード 組織 ドメイン開始

1つのドメインに対して7日間のDNS TXTチャレンジを開き、そのドメインの保留中チャレンジを置き換えます。組織の他のドメインは変更されません。返されたDNS名に正確な値を設定し維持してください。組織は最大20ドメインを保持できます(検証済みと保留を合わせて)(resource_conflict)。他の組織が保持するドメインは resource_conflict です。

組織がすでに保持するドメインは再度証明でき、日次DNSチェックの新しい値が記録されます。

認証
dashboardSession
リクエスト本文
OrganizationDomainInput
操作ID
dashboardOrganizationsStartDomain

パラメーター

名前送信する必須?説明
org_idパス必須

リクエスト本文フィールド

フィールド説明
domain(必須、文字列)正確なDNSドメイン。ワイルドカード、URL、IPアドレスは不可。minLength: 3 maxLength: 253
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/domain-challenges'

レスポンス

ステータス意味本文とヘッダー
201組織の結果。OrganizationDomainChallenge(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/organizations/{org_id}/domain-verification

ダッシュボード 組織 ドメイン検証

未期限切れのチャレンジを1つDNSに対して検証し、既に保持しているドメインの隣に組織にそのドメインを追加します。各正確なドメインは1つの組織に属します。ルックアップ中に回転した証明は拒否されます。TXTレコードはそのままにしてください。7日間レコードが見つからないドメインは毎日チェックで削除されます。

クレームが確定すると、この応答の後バックグラウンドで、所有者が正確にそのドメインで検証済みの人物であり、その所有者の個人組織に単独で存在する各プロジェクトがこの組織に移動されます(名前が衝突すると「<name> (<owner>)」にリネームされます)。

他の組織のプロジェクト、独自に顧客支払いプランを持つプロジェクト、および所有者やスタッフがドメイン組織から移動したプロジェクトはそのまま残ります。組織の制限で拒否されたプロジェクトは1日後に再試行されます。配置はアクセス権を付与しません。

認証
dashboardSession
リクエスト本文
OrganizationDomainProof
操作ID
dashboardOrganizationsVerifyDomain

パラメーター

名前送信する必須?説明
org_idパス必須

リクエスト本文フィールド

フィールド説明
challenge_id(必須、文字列)
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/domain-verification'

レスポンス

ステータス意味本文とヘッダー
200組織の結果。VerifiedOrganizationDomain(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/organizations/{org_id}/admins

ダッシュボード 組織 管理者

指定された管理者は組織の管理者、管理者候補(ライブプロジェクトの検証済みアクティブ所有者でまだ管理者でない人)、組織リビジョンを読み取ります。他は他の組織管理者ルートと同様に拒否されます。対象は人のみで、エージェントやベアラー認証には管理者ルートはありません。

認証
dashboardSession
リクエスト本文
なし
操作ID
dashboardOrganizationsAdmins

パラメーター

名前送信する必須?説明
org_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/admins'

レスポンス

ステータス意味本文とヘッダー
200組織管理者。OrganizationAdmins(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/organizations/{org_id}/admins

ダッシュボード 組織 管理者設定

指定された管理者は組織の管理者を置き換えます。If-Match は組織リビジョンを保持し、古い場合は revision_conflict と current_revision を返します。セットは1~20人を指定し、各人は現在の管理者か候補でなければなりません。そうでなければ invalid_request。管理者は他に管理者がいる場合のみ自分を削除できます。

変更はリビジョンをインクリメントし、組織の監査に記録され、プロジェクトメンバーシップは付与されず、GET と同じ形状を返します。対象は人のみで、エージェントやベアラー資格情報には管理者ルートがありません。

認証
dashboardSession
リクエスト本文
OrganizationAdminsUpdate
操作ID
dashboardOrganizationsSetAdmins

パラメーター

名前送信する必須?説明
org_idパス必須
If-Matchヘッダー必須GETからの組織リビジョン、必要に応じて引用符付き。

リクエスト本文フィールド

フィールド説明
admin_user_ids(必須、配列)
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'If-Match: "REVISION"' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/admins'

レスポンス

ステータス意味本文とヘッダー
200変更後の組織管理者。OrganizationAdmins(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/organizations/{org_id}/people

ダッシュボード 組織 メンバー

指定された管理者が組織のユーザーを読み取ります。読み取り専用です。projects は組織のライブプロジェクトを名前順に最大500件リストします。people は、組織のホームメンバー(member が true)、それらのプロジェクトのアクティブなメンバーシップ(停止中のメンバーシップは除く)、および指定された管理者の合計です。

管理者、ホームメンバー、外部ユーザー(ホームメンバーではないユーザー)の順で並び、各グループ内は表示名、次にメールアドレスの順です。

各ユーザーには、各プロジェクトでの役割(owner または member)、そのプロジェクトでレビューを承認できるかどうか(can_approve)、スクリーンまたはアップロードに限定されているかどうか(limited)、管理者かどうか、ホームメンバーかどうか(member)、組織に管理されているかどうか(managed)、そして外部ユーザーについては現在のゲストポリシーが受け入れないかどうか(outside_guest_policy)が含まれます。

どのプロジェクトにも属さない管理者やホームメンバーは、空の projects リストで表示されます。アドレスが確認されていないユーザーの email は空です。無効化されたユーザーとエージェントは表示されません。最大500人のユーザーが返され、管理者は常に含まれます。ユーザー、プロジェクト、メンバーシップが省略された場合は truncated が true になります。

それ以外のユーザーは、他の組織管理者ルートと同様に拒否されます。対象は人のみで、エージェントとベアラー認証情報にはルートがありません。

認証
dashboardSession
リクエスト本文
なし
操作ID
dashboardOrganizationsPeople

パラメーター

名前送信する必須?説明
org_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/people'

レスポンス

ステータス意味本文とヘッダー
200組織のメンバー。OrganizationPeople(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/organizations/{org_id}/admin-invitations

ダッシュボード 組織 一覧 管理者 招待

指定された管理者は組織の管理者招待をIDで50件ずつ一覧表示し、期限切れのものは削除します。受取人のアドレスは招待を提供した組織の管理者に見えます。トークンや認証URLは一覧に含まれません。対象は人のみで、エージェントやベアラー認証には管理者ルートはありません。

認証
dashboardSession
リクエスト本文
なし
操作ID
dashboardOrganizationsListAdminInvitations

パラメーター

名前送信する必須?説明
org_idパス必須
ステータスクエリオプション
カーソルクエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/admin-invitations'

レスポンス

ステータス意味本文とヘッダー
200組織の管理者招待。OrganizationAdminInvitationList(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/organizations/{org_id}/admin-invitations

ダッシュボード 組織 作成 管理者 招待

指定された管理者はメールで人を管理者に招待します。承諾すると組織の管理者に追加され、ログインがなければ作成されます。プロジェクトメンバーシップは付与されません。保留中の管理者招待を含め最大20人(organization_admin_limit)。すでに組織を管理している人物のアドレスは invalid_request です。

メール招待は7日後に期限切れとなります。同じアドレスへの未処理招待があれば再利用されます。組織名と招待者名はメールに適した内容である必要があります。ユーザーのみ対象です。エージェントやベアラ認証情報には管理者ルートがありません。

認証
dashboardSession
リクエスト本文
OrganizationAdminInvitationCreate
操作ID
dashboardOrganizationsCreateAdminInvitations

パラメーター

名前送信する必須?説明
org_idパス必須
Idempotency-Keyヘッダー必須

リクエスト本文フィールド

フィールド説明
メール(必須、配列)
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/admin-invitations'

レスポンス

ステータス意味本文とヘッダー
201組織の管理者招待は、異なるアドレスごとに1つです。OrganizationAdminInvitationCreated(application/json);ヘッダー:Cache-Control、RateLimit-Policy、RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
POST/api/organizations/{org_id}/admin-invitations/{invitation_id}/revoke

ダッシュボード 組織 管理者招待取り消し

指定された管理者は未処理の管理者招待を取り消し、管理者枠を解放します。すでに取り消された招待は204を返し、承諾済みは invitation_consumed を返します。組織が保持しないIDは not_found です。対象は人のみで、エージェントやベアラー認証には管理者ルートはありません。

認証
dashboardSession
リクエスト本文
なし
操作ID
dashboardOrganizationsRevokeAdminInvitation

パラメーター

名前送信する必須?説明
org_idパス必須
invitation_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/admin-invitations/INVITATION_ID/revoke'

レスポンス

ステータス意味本文とヘッダー
204招待は取り消されました。本文なし
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/organizations/{org_id}/member-invitations

ダッシュボード 組織 一覧 メンバー 招待

指定された管理者は組織のメンバー招待をIDで50件ずつ一覧表示し、期限が過ぎたものは先に期限切れにします。受取人のアドレスは招待を提供した組織の管理者に見えます。トークンや認証URLは一覧に含まれません。対象は人のみで、エージェントやベアラー認証には管理者ルートはありません。

認証
dashboardSession
リクエスト本文
なし
操作ID
dashboardOrganizationsListMemberInvitations

パラメーター

名前送信する必須?説明
org_idパス必須
ステータスクエリオプション
カーソルクエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/member-invitations'

レスポンス

ステータス意味本文とヘッダー
200組織のメンバー招待。OrganizationMemberInvitationList(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/organizations/{org_id}/member-invitations

ダッシュボード 組織 作成 メンバー 招待

指定された管理者は、メールで人を組織のメンバーとして招待します。承諾すると、以前のホーム組織があってもそれに代えて、その人のホーム組織がこの組織に設定され、ログインがなければ作成されます。プロジェクトメンバーシップは付与されません。

ユーザーがすでに組織のホームメンバーであるアドレスは invalid_request で、別の組織が管理しているユーザーのアドレスは managed_elsewhere です。メール招待は7日後に期限切れとなります。同じアドレスへの未処理招待があれば再利用されます。組織名と招待者名はメールに適した内容である必要があります。

スタッフ組織(plan_id staff)への招待を承諾すると、その人もスタッフになるため、この招待を送信できるのはスタッフだけです。リクエストごとに宛先は1件で、その宛先に紐づく staff_grant 証明が必要です(証明がなければ reauthentication_required)。対象は人のみで、エージェントや bearer 認証情報には管理用ルートがありません。

認証
dashboardSession
リクエスト本文
OrganizationMemberInvitationCreate
操作ID
dashboardOrganizationsCreateMemberInvitations

パラメーター

名前送信する必須?説明
org_idパス必須
Idempotency-Keyヘッダー必須

リクエスト本文フィールド

フィールド説明
メール(必須、配列)
proof(任意、DashboardProof)
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/member-invitations'

レスポンス

ステータス意味本文とヘッダー
201組織のメンバー招待は、異なるアドレスごとに1つです。OrganizationMemberInvitationCreated(application/json);ヘッダー:Cache-Control、RateLimit-Policy、RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
POST/api/organizations/{org_id}/member-invitations/{invitation_id}/revoke

ダッシュボード 組織 メンバー招待取り消し

指定された管理者は未処理のメンバー招待を取り消します。すでに取り消された招待は204を返し、承諾済みは invitation_consumed を返します。組織が保持しないIDは not_found です。対象は人のみで、エージェントやベアラー認証には管理者ルートはありません。

認証
dashboardSession
リクエスト本文
なし
操作ID
dashboardOrganizationsRevokeMemberInvitation

パラメーター

名前送信する必須?説明
org_idパス必須
invitation_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/member-invitations/INVITATION_ID/revoke'

レスポンス

ステータス意味本文とヘッダー
204招待は取り消されました。本文なし
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/organizations/{org_id}/members/{user_id}

ダッシュボード 組織 メンバー削除

指定された管理者が組織からホームメンバーを削除します。

1つのトランザクションで、ユーザーのホーム組織が解除され、組織のすべてのライブプロジェクトでのメンバーシップが、そのプロジェクトから削除した場合と同じ扱いで終了します(そのプロジェクトへの未処理のメール招待は取り消され、セッションはプロジェクトを解決しなくなります)。他の組織のプロジェクトでのメンバーシップには影響せず、ほかの組織も変更されません。

変更は組織の監査に記録されます。

IDプロバイダーが管理するユーザー(シングルサインオンまたは SCIM)は managed_member、指定された管理者は organization_admin_member(先に PUT /api/organizations/{org_id}/admins で管理者枠を削除してください)、組織のライブプロジェクトを所有するユーザーは member_owns_projects で、詳細にプロジェクト名が一覧されます(先にそれらのプロジェクトを移譲してください。何も削除されません)。組織のホームメンバーでないユーザー(すでに削除された人を含む)は not_found です。

対象は人のみで、エージェントやベアラー認証には管理者ルートはありません。

認証
dashboardSession
リクエスト本文
なし
操作ID
dashboardOrganizationsRemoveMember

パラメーター

名前送信する必須?説明
org_idパス必須
user_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/members/USER_ID'

レスポンス

ステータス意味本文とヘッダー
204このユーザーは組織のメンバーではなくなりました。本文なし
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/organizations/{org_id}/guest-policy

ダッシュボード 組織 ゲストポリシー設定

指定された管理者は、組織がプロジェクトにゲスト(ホーム組織が別の組織であるか、ホーム組織を持たない人)として受け入れる対象を設定します。mode が allow(デフォルト)の場合はすべてのゲストを受け入れ、domains の場合は検証済みメールアドレスが domains のいずれかにあるゲストを受け入れ、none の場合はゲストを一切受け入れません。domains には、重複しない小文字の DNS 名を1~20件指定します。mode が domains の場合は必須で、それ以外では省略します。それ以外は invalid_request です。

ポリシーは以前のものを置き換え、組織のリビジョンをインクリメントし、組織の監査に記録され、適用中のポリシーを返します。組織がゲストにプロジェクトメンバーシップを付与するとき、つまりプロジェクトメンバー招待(作成と承諾)および SCIM グループの紐付けの際にチェックされ、拒否された場合は guest_not_allowed が返されます。

スタッフと組織自身の管理者は対象外で、エージェントはチェックされず、ホームメンバーはゲストになりません。ポリシーを厳しくしても誰も削除されません。outside_policy は、新しいポリシーが受け入れない、すでに組織のライブプロジェクトにいる外部ユーザーの数で、GET /api/organizations/{org_id}/people はそれぞれに印を付けます(outside_guest_policy)。

対象は人のみで、エージェントやベアラー認証には管理者ルートはありません。

認証
dashboardSession
リクエスト本文
OrganizationGuestPolicyUpdate
操作ID
dashboardOrganizationsSetGuestPolicy

パラメーター

名前送信する必須?説明
org_idパス必須

リクエスト本文フィールド

フィールド説明
mode(必須、OrganizationGuestPolicyMode)

allow はすべてのゲストを受け入れます。domains は検証済みメールアドレスが一覧のドメインのいずれかにあるゲストを受け入れます(完全一致)。none はゲストを一切受け入れません。ホームメンバーがゲストになることはありません。許可:"allow"、"domains"、"none"

domains(任意、配列)mode が domains の場合は必須です(domains は1~20件、重複は拒否されます)。allow と none では省略します。どちらの場合も、形が正しくなければ invalid_request です。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/guest-policy'

レスポンス

ステータス意味本文とヘッダー
200現在適用中のゲストポリシーです。OrganizationGuestPolicyResult(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/organizations/{org_id}/library

ダッシュボード 組織 ライブラリ設定

指定された管理者が、組織のライブラリプロジェクトを設定または解除します。project_id には組織の有効なプロジェクトの 1 つを指定し、null を指定すると解除されます。

組織の他のすべてのプロジェクトは、ライブラリのメディア、メディアフォルダー、プレイリストを読み取り(GET /api/media、/api/media-folders、/api/playlists の library=true、および ID 指定)、読み取り専用で使います。対象は、ページのメディア参照、ライブラリのフォルダーを指定する by:folder セレクター(タグセレクターと all セレクターはライブラリに届きません)、スクリーンのスケジュールとスタック、from_template です。変更できるのはライブラリ自身のメンバーだけです。

ライブラリプロジェクトにはスクリーンがありません。スクリーンのあるプロジェクトは library_no_screens となり、その後ライブラリにスクリーンを追加することもできません。ライブラリの設定にはプラン機能 library が必要です(Premium、Education、Enterprise。それ以外は feature_not_in_plan)。解除には不要で、ダウングレード後も維持されたライブラリは引き続き提供されます。

ライブラリを解除または置き換えると、その項目を指定しているメンバープロジェクトのプレイリストは、次に書き込まれる時点で解決できなくなり、スクリーンはそのメディアを受け取らなくなります。ライブラリであるプロジェクトを削除するか、組織の外へ移動すると、ライブラリは解除されます。

組織ビューを返し、組織の監査に記録され(organization.library_changed)、リビジョンを加算します。対象は人のみです。

認証
dashboardSession
リクエスト本文
OrganizationLibraryUpdate
操作ID
dashboardOrganizationsSetLibrary

パラメーター

名前送信する必須?説明
org_idパス必須

リクエスト本文フィールド

フィールド説明
project_id(必須、インライン)組織のライブラリにするプロジェクト。ライブラリを解除する場合は null。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/library'

レスポンス

ステータス意味本文とヘッダー
200ライブラリが適用された組織です。OrganizationView(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/organizations/{org_id}/project-access

ダッシュボード 組織 プロジェクトアクセス設定

指定された管理者は、複数のユーザーの、組織の複数のライブプロジェクトへのアクセスを、どのプロジェクトにも参加せずに、1回のリクエストでまとめて設定します。

1〜500件の各変更は、プロジェクト、ユーザー、アクセスを指定します。同じ (project_id, user_id) の組を2回指定することはできません。member はそのユーザーを、レビューを承認できないプロジェクトのメンバーにします(メンバーでない場合は追加され、approver だった場合は承認権限を失います)。approver は承認できるメンバーにします(メンバーでない場合は追加されます)。none はメンバーにしません(メンバーである場合は削除されます)。

すべてが1つのトランザクションで順に適用され、1件でも拒否されるとバッチ全体が取り消されます。各拒否は、errors[].field で changes[i](プロジェクトまたはユーザー)または changes[i].access を指します。

この組織のライブプロジェクトでないプロジェクトは not_found です。有効なユーザーでない人(エージェント、無効化されたユーザー、不明な id)またはスタッフ、停止中のメンバーシップ、組織のユーザー(管理者、ホームメンバー、組織の他のライブプロジェクトのアクティブなメンバー。それ以外のユーザーは招待を通じて参加します)に含まれないユーザーの追加は invalid_request です。オーナーを member や none に設定することはできません(owner_cannot_leave)。アップローダーが承認者になることはありません(resource_conflict。PUT /api/members/{user_id}/approver の応答と同じ)。管理者自身を削除することは禁止されています(管理者は DELETE /api/members/{user_id} で退出します)。追加されるユーザーは招待で受け入れられる場合と同じ基準で受け入れられるため、ホームメンバーと組織の管理者は常に、外部ユーザーは現在のゲストポリシーが受け入れる場合に限り追加できます(guest_not_allowed)。

追加には、プロジェクトの200メンバーの上限とプランのメンバー数の上限が適用されます(member_limit_reached)。応答はすべての変更をリクエストの順に繰り返します。アクセスがすでに有効だった変更は changed が false になり、何も書き込まれず、記録もされません。

各変更は組織の監査(organization.project_member_added、organization.project_member_approver_changed または organization.project_member_removed)とプロジェクトのイベント(member.added_by_organization_admin、project.member_approver_changed または member.removed。組織の管理者によるものとして記録)に記録され、各プロジェクトのオーナーには、本人が行った場合を除き、バッチごとに1回メールが送信されます。

対象は人のみで、エージェントやベアラー認証には管理者ルートはありません。

認証
dashboardSession
リクエスト本文
OrganizationProjectAccessRequest
操作ID
dashboardOrganizationsSetProjectAccess

パラメーター

名前送信する必須?説明
org_idパス必須

リクエスト本文フィールド

フィールド説明
changes(必須、配列)順に適用される変更。同じ (project_id, user_id) の組は2回指定できません。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/project-access'

レスポンス

ステータス意味本文とヘッダー
200適用された変更を、リクエストの順に返します。OrganizationProjectAccessResult(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/organizations/{org_id}/projects/{project_id}/access

ダッシュボード 組織 プロジェクト参加

指定された管理者は、組織のライブプロジェクトの1つに、スクリーンスコープもアップロードスコープもなく、レビューを承認できるメンバーとして参加します。参加することで、管理者はプロジェクトのコンテンツにアクセスできるようになります。組織のルートにはコンテンツは表示されません。

すでにスコープなしで承認できるメンバーである管理者には、joined が false の 200 が返され、何も変わりません。スクリーンまたはアップロードのスコープを持つメンバー、または承認できないメンバーは、スコープなしで承認できるメンバーになり、参加として記録されます。

プロジェクトの200メンバー上限が適用されます(member_limit_reached)。組織のゲストポリシーが組織自身の管理者に適用されることはありません。参加は組織の監査に organization.project_joined として、プロジェクトのイベントに member.added_by_organization_admin として記録され、プロジェクトのオーナーにメールが送信されます。

組織が保持しない、または削除されたプロジェクトは not_found です。対象は人のみで、エージェントやベアラー認証には管理者ルートはありません。

認証
dashboardSession
リクエスト本文
なし
操作ID
dashboardOrganizationsJoinProject

パラメーター

名前送信する必須?説明
org_idパス必須
project_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/projects/PROJECT_ID/access'

レスポンス

ステータス意味本文とヘッダー
200管理者はプロジェクトのメンバーです。OrganizationProjectAccess(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/organizations/{org_id}/projects/{project_id}/owner

ダッシュボード 組織 プロジェクトオーナー設定

指定された管理者は、組織のライブプロジェクトの1つに参加せずに、現在のオーナー(アカウントが無効化されているオーナーを含む)から所有権を移し、ユーザーをそのプロジェクトのオーナーにします。

新しいオーナーは、プロジェクトのメンバーであるか、組織のホームメンバーである、検証済みのアクティブなユーザーです(プロジェクトのメンバーではないホームメンバーは、先に、スクリーンスコープもアップロードスコープもなくレビューを承認できるメンバーとして追加されます。ホームメンバーにはゲストポリシーは適用されません)。それ以外は user_id で invalid_request です。

管理者が自分自身をオーナーにできるのは、プロジェクトに参加した後のみです(POST /api/organizations/{org_id}/projects/{project_id}/access)。スクリーンスコープもアップロードスコープもなく承認できるメンバーでない場合は、user_id で invalid_request です。

効果はオーナー自身による移譲と同じで、新しいオーナーのスクリーンスコープとアップロードスコープは解除され、プロジェクトの従来の責任は新しいオーナーに紐付けられます。現在のオーナーを指定しても何も変わりません。変更は組織の監査に organization.project_owner_changed として記録され、以前のオーナーと新しいオーナーにメールが送信されます。

プロジェクトの200メンバー上限は、追加されるホームメンバーに適用されます(member_limit_reached)。組織が保持しない、または削除されたプロジェクトは not_found です。対象は人のみで、エージェントやベアラー認証には管理者ルートはありません。

認証
dashboardSession
リクエスト本文
OrganizationProjectOwnerUpdate
操作ID
dashboardOrganizationsSetProjectOwner

パラメーター

名前送信する必須?説明
org_idパス必須
project_idパス必須

リクエスト本文フィールド

フィールド説明
user_id(必須、文字列)新しいオーナー。プロジェクトのメンバーであるか、組織のホームメンバーである、検証済みのアクティブなユーザー。minLength:1 maxLength:200
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/projects/PROJECT_ID/owner'

レスポンス

ステータス意味本文とヘッダー
200変更後のプロジェクトのオーナー。OrganizationProjectOwner(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/organizations/{org_id}/projects/{project_id}/members/{user_id}

ダッシュボード 組織 プロジェクトメンバー削除

指定された管理者は、組織のライブプロジェクトの1つに参加せずに、そのプロジェクトからメンバーを削除します。オーナーによる削除(DELETE /api/members/{user_id})と同じ効果があります。メンバーシップが終了し、そのユーザーのプロジェクトへの未処理のメール招待が取り消され、セッションはプロジェクトを解決しなくなり、エージェントのメンバーシップは残ります。

オーナーは削除されません(owner_cannot_leave。先に PUT /api/organizations/{org_id}/projects/{project_id}/owner で所有権を移譲してください)。プロジェクトのメンバーでないユーザー(すでに削除された人を含む)、および組織が保持しない、または削除されたプロジェクトは not_found です。

削除は、組織の監査に organization.project_member_removed として、プロジェクトのイベントに removed_by_organization_admin が true の member.removed として記録されます。対象は人のみで、エージェントやベアラー認証には管理者ルートはありません。

認証
dashboardSession
リクエスト本文
なし
操作ID
dashboardOrganizationsRemoveProjectMember

パラメーター

名前送信する必須?説明
org_idパス必須
project_idパス必須
user_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/projects/PROJECT_ID/members/USER_ID'

レスポンス

ステータス意味本文とヘッダー
204メンバーシップが終了しました。本文なし
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/organizations/{org_id}/domains/{domain}

ダッシュボード 組織 ドメイン削除

1つのドメイン(検証済みまたは保留中)を削除し、組織の他のドメインは残します。今後の配置と検出は停止し、別の組織が検証できるようになります。組織に既にあるプロジェクトは残ります。組織が所有も証明もしていないドメインは not_found です。

組織がシングルサインオンを必須にしている間、検証済みドメインは resource_conflict です。シングル サインオンを必須にするをオフにすると 72 時間後に有効になり、その時点でドメインを削除できます。

認証
dashboardSession
リクエスト本文
なし
操作ID
dashboardOrganizationsRemoveOneDomain

パラメーター

名前送信する必須?説明
org_idパス必須
domainパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/domains/DOMAIN'

レスポンス

ステータス意味本文とヘッダー
200組織の結果。OrganizationDomainRemoved(application/json);ヘッダー:Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/members/{user_id}/approver

ダッシュボードメンバー承認者を設定

メンバーが承認できるかどうかを設定します:レビューを決定し、エージェントに Manage アクセスを付与します。承認できないメンバーのエージェントは Propose に制限されます。実行できるのはプロジェクトのオーナー、またはプロジェクトの組織を管理するメンバーのみ(それ以外は forbidden)、オーナー自身の行は固定(resource_conflict)、メンバーでない場合は not_found です。

project.member_approver_changed を追加します(詳細は user_id、can_approve)。

認証
dashboardSession
リクエスト本文
MemberApproverUpdate
操作ID
setDashboardMemberApprover

パラメーター

名前送信する必須?説明
user_idパス必須

リクエスト本文フィールド

フィールド説明
can_approve(必須、boolean)
project_id(任意、文字列)呼び出し元が意味するプロジェクト。選択が変更されたセッションはresource_conflictで拒否されます。minLength:1 maxLength:200
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/members/USER_ID/approver'

レスポンス

ステータス意味本文とヘッダー
200メンバー。ダッシュボードメンバー(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/members/{user_id}/screen-scope

ダッシュボードメンバーのスクリーンスコープを設定

メンバーをスクリーンフォルダー(それぞれ内側のすべてのフォルダーを含む)とスクリーンに限定するか、そのスコープを置き換えます(docs/screen-scope.md)。

1つのトランザクションで、そのユーザーがプロジェクトに連れてきたエージェントも終了し(メンバーを削除した場合と同様に agent.disconnected)、project.member_screen_scope_changed を追加します(詳細は user_id、screen_scope、previous、changed_by_user_id)。スコープはメンバーの次のリクエストで読み取られます。変更は、再度サインインしなくても、次の GET /api/session に反映されます。

実行できるのはプロジェクトのオーナー、またはプロジェクトの組織を管理するメンバーのみ(それ以外は forbidden)。オーナー自身の行、アップローダー(スコープ付きメンバーはスクリーンに、アップローダーはコンテンツに限定されます)、およびスコープ内に個別のスクリーンを持つレビュー承認メンバーは resource_conflict です。メンバーでない場合は not_found です。プロジェクトの有効なスクリーンフォルダーまたはスクリーンではないIDは、screen_scope.folder_ids[i] または screen_scope.screen_ids[i] で invalid_request です。

レビューを承認するスコープ付きメンバーが承認できるのはスコープ内のみです。承認できないメンバーは、読み取りとコマンドの実行はできますが、再生内容の変更は承認者を通じてのみ可能です(approver_required)。

スコープは、そのユーザー、またはそのユーザーが連れてきたエージェントがプロジェクトの有効なサービスクライアントを持っている間も、resource_conflict で拒否されます。詳細には最大5つのクライアントが ID(名前)として示され、残りは件数で示されます。何も書き込まれません。

ユーザーをスクリーンに限定することはスクリーンのスコープであり、Enterprise プランに含まれます。プランにこの機能が含まれていないプロジェクトは feature_not_in_plan(402)で拒否されます。設定されたスコープは、クリア(DELETE)されるまでユーザーを制限し続けます。クリアはすべてのプランで行えます。

認証
dashboardSession
リクエスト本文
MemberScreenScopeUpdate
操作ID
setDashboardMemberScreenScope

パラメーター

名前送信する必須?説明
user_idパス必須

リクエスト本文フィールド

フィールド説明
screen_scope(必須、ScreenScope)

スコープ付きメンバーまたはエージェントが操作できる対象(docs/screen-scope.md):一覧のスクリーンフォルダーとその内側のすべてのフォルダーにあるスクリーン、および一覧のスクリーン。合計で少なくとも1つのID。書き込み時にプロジェクトの有効なフォルダーまたはスクリーンを指さないIDは、その位置で invalid_request です。後で削除されると、何も付与しない無効なIDが残ります。

スコープはリクエストごとに読み取られるため、変更は次のリクエストから適用されます。タグはスコープになりません。

project_id(任意、文字列)MemberApproverUpdate と同じ。minLength: 1 maxLength: 200
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/members/USER_ID/screen-scope'

レスポンス

ステータス意味本文とヘッダー
200メンバー(screen_scope 付き)。ダッシュボードメンバー(application/json)
402feature_not_in_plan — スクリーンのスコープは Enterprise プランに含まれます。問題には、機能、アカウントのプラン、required_plan が示されます。問題 (application/problem+json)
403forbidden - スコープを設定できるのはプロジェクトのオーナー、またはプロジェクトの組織を管理するメンバーのみです。スクリーンに限定されたメンバーには outside_screen_scope です。プロジェクトオーナーに依頼してください。問題 (application/problem+json)
409

resource_conflict - オーナー自身の行、アップローダー、スコープ内に個別のスクリーンを持つ承認者、またはそのユーザーまたはそのユーザーが連れてきたエージェントの有効なサービスクライアント。指定された各クライアントを screenrig service-client revoke ID で取り消し、もう一度スコープを設定してください。

問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/members/{user_id}/screen-scope

ダッシュボードメンバーのスクリーンスコープをクリア

スコープ付きメンバーに、プロジェクト全体のスクリーンを再び与えます。実行できるのはプロジェクトのオーナー、またはプロジェクトの組織を管理するメンバーのみで、スコープのないメンバーはそのままです。screen_scope を null にして project.member_screen_scope_changed を追加します。

認証
dashboardSession
リクエスト本文
なし
操作ID
clearDashboardMemberScreenScope

パラメーター

名前送信する必須?説明
user_idパス必須
project_idクエリオプション呼び出し元が意味するプロジェクト。選択が変わったセッションはresource_conflictで拒否されます。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/members/USER_ID/screen-scope'

レスポンス

ステータス意味本文とヘッダー
200メンバー。ダッシュボードメンバー(application/json)
403forbidden - スコープを設定できるのはプロジェクトのオーナー、またはプロジェクトの組織を管理するメンバーのみです。スクリーンに限定されたメンバーには outside_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)
PUT/api/agents/{id}/screen-scope

ダッシュボードエージェントのスクリーンスコープを設定

セッションプロジェクトでのエージェントのメンバーシップを、スクリーンフォルダーとスクリーンに限定するか、そのスコープを置き換えます(docs/screen-scope.md)。エージェントの到達範囲は、このスコープを責任者のスコープで絞り込んだものであり、スコープ付きのユーザーが、自分より広いエージェントを通じて操作することはありません。

実行できるのはプロジェクトのオーナー、またはプロジェクトの組織を管理するメンバーのみ(それ以外は forbidden)。プロジェクトのメンバーではないエージェントは not_found です。agent.screen_scope_changed を追加します(詳細は agent_id、screen_scope、previous、changed_by_user_id)。

エージェントのスコープは、書き込んだインスタンスでは次のリクエストから、ほかのインスタンスでは2秒以内に適用されます。スコープは、エージェントがプロジェクトの有効なサービスクライアントを持っている間は resource_conflict で拒否されます。詳細には最大5つのクライアントが ID(名前)として示され、残りは件数で示されます。何も書き込まれません。

エージェントをスクリーンに限定することはスクリーンのスコープであり、Enterprise プランに含まれます。プランにこの機能が含まれていないプロジェクトは feature_not_in_plan(402)で拒否されます。設定されたスコープは、クリア(DELETE)されるまでエージェントを制限し続けます。クリアはすべてのプランで行えます。

認証
dashboardSession
リクエスト本文
AgentScreenScopeUpdate
操作ID
setDashboardAgentScreenScope

パラメーター

名前送信する必須?説明
IDパス必須

リクエスト本文フィールド

フィールド説明
screen_scope(必須、ScreenScope)

スコープ付きメンバーまたはエージェントが操作できる対象(docs/screen-scope.md):一覧のスクリーンフォルダーとその内側のすべてのフォルダーにあるスクリーン、および一覧のスクリーン。合計で少なくとも1つのID。書き込み時にプロジェクトの有効なフォルダーまたはスクリーンを指さないIDは、その位置で invalid_request です。後で削除されると、何も付与しない無効なIDが残ります。

スコープはリクエストごとに読み取られるため、変更は次のリクエストから適用されます。タグはスコープになりません。

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/agents/RESOURCE_ID/screen-scope'

レスポンス

ステータス意味本文とヘッダー
200エージェント(screen_scope 付き)。Agent(application/json)
402feature_not_in_plan — スクリーンのスコープは Enterprise プランに含まれます。問題には、機能、アカウントのプラン、required_plan が示されます。問題 (application/problem+json)
403forbidden - スコープを設定できるのはプロジェクトのオーナー、またはプロジェクトの組織を管理するメンバーのみです。スクリーンに限定されたメンバーには outside_screen_scope です。プロジェクトオーナーに依頼してください。問題 (application/problem+json)
409resource_conflict - エージェントがプロジェクトの有効なサービスクライアントを持っています。指定された各クライアントを screenrig service-client revoke ID で取り消し、もう一度スコープを設定してください。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/agents/{id}/screen-scope

ダッシュボードエージェントのスクリーンスコープをクリア

セッションプロジェクトでのエージェントのメンバーシップのスコープを削除します。実行できるのはプロジェクトのオーナー、またはプロジェクトの組織を管理するメンバーのみです。screen_scope を null にして agent.screen_scope_changed を追加します。

認証
dashboardSession
リクエスト本文
なし
操作ID
clearDashboardAgentScreenScope

パラメーター

名前送信する必須?説明
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/agents/RESOURCE_ID/screen-scope'

レスポンス

ステータス意味本文とヘッダー
200エージェント。Agent(application/json)
403forbidden - スコープを設定できるのはプロジェクトのオーナー、またはプロジェクトの組織を管理するメンバーのみです。スクリーンに限定されたメンバーには outside_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)
PUT/api/members/{user_id}/upload-scope

ダッシュボードメンバーのアップロード範囲を設定

メンバーをアップローダーにするか、アップローダーの範囲を置き換えます(docs/uploaders.md)。ページを変更できるプレイリストと、アップロード先のメディアフォルダーが対象です。

同一トランザクションで、レビューの承認も停止し、そのメンバーがプロジェクトに連れてきたエージェントを終了し(削除した場合と同様に agent.disconnected)、project.member_upload_scope_changed を追加します(詳細は user_id、upload_scope、changed_by_user_id)。

範囲はメンバーの次のリクエストで読み込まれます。変更は、再度サインインしなくても次の GET /api/session に反映されます。

実行できるのはプロジェクトのオーナー、またはプロジェクトの組織を管理するメンバーのみ(それ以外は forbidden)。オーナー自身の行は resource_conflict、メンバーでない場合は not_found、プロジェクトの有効なプレイリストまたはメディアフォルダーではないIDは upload_scope.playlist_ids[i] または upload_scope.folder_ids[i] で invalid_request になります。access が propose(デフォルト)の場合、アップローダーの変更はレビューに送られ、manage の場合は公開されます。

スクリーンに限定されたメンバーは resource_conflict です。先にそのスコープを解除してください(DELETE /api/members/{user_id}/screen-scope)。

認証
dashboardSession
リクエスト本文
MemberUploadScopeUpdate
操作ID
setDashboardMemberUploadScope

パラメーター

名前送信する必須?説明
user_idパス必須

リクエスト本文フィールド

フィールド説明
upload_scope(必須、UploadScope)

アップローダーが使えるもの(docs/uploaders.md):ページを変更できるプレイリストと、アップロード先のメディアフォルダー。フォルダーは一覧されたものそのもので、サブフォルダーは含まれません。書き込み時にプロジェクトの有効なオブジェクトを指していないIDは、その位置で invalid_request になります。後から削除されたものは無効なIDとして残りますが、何も許可しません。

範囲はリクエストごとに読み込まれるため、変更は次のリクエストから適用されます。

project_id(任意、文字列)MemberApproverUpdate と同じ。minLength: 1 maxLength: 200
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/members/USER_ID/upload-scope'

レスポンス

ステータス意味本文とヘッダー
200メンバー(upload_scope 付き)。ダッシュボードメンバー(application/json)
402

feature_not_in_plan — アップロードスコープはアップローダーを作り、プロジェクトのプランにはアップローダーが含まれていません。required_plan が、含まれるプランを示します。スコープの絞り込みと削除は常に許可されます。

問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/members/{user_id}/upload-scope

ダッシュボードメンバーのアップロード範囲をクリア

アップローダーを再び通常のメンバーに戻します。通常のメンバーになってもレビューは承認しません(承認を有効にするには setDashboardMemberApprover を使用)。実行できるのはプロジェクトのオーナー、またはプロジェクトの組織を管理するメンバーのみで、アップローダーでないメンバーはそのままです。upload_scope を null にして project.member_upload_scope_changed を追加します。

認証
dashboardSession
リクエスト本文
なし
操作ID
clearDashboardMemberUploadScope

パラメーター

名前送信する必須?説明
user_idパス必須
project_idクエリオプション呼び出し元が意味するプロジェクト。選択が変わったセッションはresource_conflictで拒否されます。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/members/USER_ID/upload-scope'

レスポンス

ステータス意味本文とヘッダー
200メンバー。ダッシュボードメンバー(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)