screenRIG
サインイン開始する

API リファレンス

シングルサインオン API

シングルサインオン：サインインのルート、IDプロバイダー、ポリシー

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

OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要

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

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

シングルサインオン：サインインのルート、IDプロバイダー、ポリシー

POST/api/sso/discovery

ダッシュボードSSOを検出

メールアドレスがサインインまたはサインアップする方法をエントリーページに伝えます。sso、required、provider_name は、有効な ID プロバイダー接続を持つ組織の検証済みドメインと照合して、アドレスのドメインのみで決まります。そのような組織がそのドメインを保持している場合、sso は true です。その組織がシングルサインオンを必須としている場合、required は true で、そのドメインでのパスワードとパスキーによるサインインは拒否されます（createDashboardSession は sso_required を返します）。ブレークグラス管理者はパスキーでのサインインを維持します。provider_name は接続の表示名で、sso が true の場合のみ含まれます。account は、有効なユーザーが検証済みかどうかにかかわらずそのアドレスを保持している場合に true、誰も保持していない場合に false です。true の場合、ページはそのユーザーをサインインさせ、false で sso が false の場合は、サインアップ（POST /api/signups）を案内します。

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

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

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

フィールド説明
email（必須、文字列）ユーザーが入力したアドレス。読み取られるのはドメインのみです。minLength: 3 maxLength: 254 format: "email"
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/sso/discovery'

レスポンス

ステータス意味本文とヘッダー
200ドメインのシングルサインオンに関する応答。SSODiscovery（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)
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/sso/starts

ダッシュボードSSOを開始

アドレスのドメインを保持する組織のIDプロバイダーを通じて、シングルサインオンによるサインインを開始し、ページが遷移するプロバイダーのアドレスを返します。レスポンスは __Host-screenrig-sso クッキー（HttpOnly、Secure、SameSite=Strict、Path=/、10 分）を設定し、このブラウザーをサインインに結び付けます。

OIDC 接続には、PKCE S256、nonce、response_mode form_post を用いた認可コードフローが要求されます。SAML 接続には HTTP-Redirect の AuthnRequest が送られます。

プロバイダーは接続の /api/sso/oidc/{connection_id}/callback または /api/sso/saml/{connection_id}/acs に POST して応答し、サインインは /api/sso/finish で終了します。return_to はサインイン後に移動する /dashboard/ 配下のパスで、省略すると /dashboard/ に移動します。invitation_token は、ユーザーがサインインした時点でサインインが承諾する招待です。prompt が none の場合はプロバイダーにサイレントなサインインを求めます。ユーザーの操作が必要な場合、サインインは /dashboard/#sso_error=interaction_required で終了します。prompt が login の場合は、プロバイダーにユーザーを再度認証させます。

ドメインに有効な接続がないアドレスは not_found です。クライアントアドレスごとに制限されます。

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

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

フィールド説明
email（必須、文字列）ユーザーが入力したアドレス。そのドメインによって組織の接続が選択されます。minLength: 3 maxLength: 254 format: "email"
return_to（任意、文字列）サインイン後に移動する /dashboard/ 配下のパス。省略すると /dashboard/ に移動し、それ以外の値は invalid_request です。minLength: 1 maxLength: 512 pattern: "^/dashboard/"
invitation_token（任意、文字列）ユーザーがサインインした時点で、サインインがそのユーザーのために承諾する招待。pattern: "^[A-Za-z0-9_-]{43}$"
prompt（任意、文字列）none はプロバイダーにサイレントなサインインを求め、ログインヒントを渡さないため、email はドメインの選択にのみ使われます。login はプロバイダーにユーザーを再度認証させます。許可："none"、"login"
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/sso/starts'

レスポンス

ステータス意味本文とヘッダー
200遷移先のIDプロバイダーのアドレスと、トランザクションクッキー。SSOStart（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)
404

安定した 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/sso/oidc/{connection_id}/callback

ダッシュボードSSO OIDCコールバックを受信

1 つの接続の OIDC リダイレクト URI。IDプロバイダーは別のサイトからここに POST する（response_mode form_post）ため、ダッシュボードのクッキーは届きません。このルートは誰もサインインさせません。同じメンバーと接続 ID をダッシュボードのオリジンから /api/sso/finish に POST するページを返し、そのオリジンにはトランザクションクッキーが届きます。

応答が完了させるのは、この接続が開始したサインインのみです。それ以外は /dashboard/#sso_error=bad_state で終了します。プロバイダーのディスカバリードキュメントが authorization_response_iss_parameter_supported を設定している場合、iss を含まない応答（RFC 9207）は /dashboard/#sso_error=verification_failed で終了します。

このページは nonce で保護されたインラインスクリプトを 1 つ実行し、noscript 用のボタンを備えます。Content-Security-Policy は厳格で、Cache-Control は no-store、Referrer-Policy は no-referrer です。どの接続にも属さない ID は not_found です。

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

パラメーター

名前送信する必須？説明
connection_idパス必須

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

フィールド説明
state（必須、文字列）maxLength: 512
code（任意、文字列）maxLength: 8192
error（任意、文字列）maxLength：200
error_description（任意、文字列）maxLength: 2048
iss（任意、文字列）maxLength: 2048
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Content-Type: application/x-www-form-urlencoded' --data-binary '@request.bin' 'https://screenrig.ai/api/sso/oidc/CONNECTION_ID/callback'

レスポンス

ステータス意味本文とヘッダー
200プロバイダーの応答を /api/sso/finish に POST するページ。string（text/html）；ヘッダー：Cache-Control、Referrer-Policy、Content-Security-Policy
400

安定した 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)
デフォルト

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

問題 (application/problem+json)
GET/api/sso/saml/{connection_id}

ダッシュボードSSO SAMLメタデータを取得

1 つの接続の SAML サービスプロバイダーメタデータ。entityID はこのルートのアドレスで、アサーションコンシューマーサービスは HTTP-POST バインディングの /api/sso/saml/{connection_id}/acs です。IDプロバイダーの管理者がこれをインポートするか、接続の service_provider から同じ値をコピーします。どの接続にも属さない ID は not_found です。

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

パラメーター

名前送信する必須？説明
connection_idパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET 'https://screenrig.ai/api/sso/saml/CONNECTION_ID'

レスポンス

ステータス意味本文とヘッダー
200サービスプロバイダーのメタデータドキュメント。string（application/samlmetadata+xml）
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/sso/saml/{connection_id}/acs

ダッシュボードSSO SAMLアサーションを受信

1 つの接続の SAML アサーションコンシューマーサービス。IDプロバイダーは別のサイトからここに POST するため、ダッシュボードのクッキーは届きません。このルートは誰もサインインさせません。SAMLResponse、その RelayState、接続 ID をダッシュボードのオリジンから /api/sso/finish に POST するページを返し、そのオリジンにはトランザクションクッキーが届きます。

応答が完了させるのは、この接続が開始したサインインのみです。このページは nonce で保護されたインラインスクリプトを 1 つ実行し、noscript 用のボタンを備えます。Content-Security-Policy は厳格で、Cache-Control は no-store、Referrer-Policy は no-referrer です。どの接続にも属さない ID は not_found です。

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

パラメーター

名前送信する必須？説明
connection_idパス必須

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

フィールド説明
SAMLResponse（必須、文字列）maxLength: 1048576
RelayState（任意、文字列）maxLength: 512
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Content-Type: application/x-www-form-urlencoded' --data-binary '@request.bin' 'https://screenrig.ai/api/sso/saml/CONNECTION_ID/acs'

レスポンス

ステータス意味本文とヘッダー
200プロバイダーの応答を /api/sso/finish に POST するページ。string（text/html）；ヘッダー：Cache-Control、Referrer-Policy、Content-Security-Policy
400

安定した 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)
デフォルト

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

問題 (application/problem+json)
POST/api/sso/finish

ダッシュボードSSOを完了

ダッシュボードのオリジンでシングルサインオンによるサインインを完了します。このオリジンには __Host-screenrig-sso クッキーが届きます。フォームは state、応答が届いた接続、およびコールバックページがコピーしたIDプロバイダーの応答です。OIDC では code、error、error_description、iss、SAML では SAMLResponse です（state は RelayState）。

このルートは state をクッキーに結び付け、サインインを開始した接続とは別の接続に届いた応答を拒否し、プロバイダーのトークンまたはアサーションを検証し、アカウントの引き継ぎとリンクのルールを適用し、組織のサインインポリシーを確認して、303 で応答します。

サインイン、更新、再認証のいずれでも、auth_method が sso のダッシュボードセッションが発行されます。このセッションはこのサインインから 24 時間有効で、利用しても延長されません。サインインに付随する招待を承諾し、__Host-screenrig-dashboard クッキーを設定し、トランザクションクッキーを失効させ、return_to に、なければ /dashboard/ にリダイレクトします。

リンク用のサインインは、サインイン中のユーザーのアカウントにアイデンティティを追加し、そのセッションを維持します。テスト用のサインインは、結果を接続に記録し（last_test）、誰もサインインさせません。失敗はすべて 303 で /dashboard/#sso_error=<code> にリダイレクトされ、問題ドキュメントで応答することはありません。

コードは no_email、email_unverified、domain_not_allowed、account_exists（ユーザーはこれまでどおりサインインし、アカウントからリンクします）、managed_elsewhere、subject_mismatch、not_provisioned、sso_required、staff_account、expired、bad_state、interaction_required（サイレント更新にはユーザーの操作が必要）、provider_refused、provider_unavailable、verification_failed、deactivated です（SSOErrorCode）。

認証
ssoTransaction
リクエスト本文
object
操作ID
finishDashboardSSO

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

フィールド説明
connection_id（任意、文字列）maxLength: 128
state（必須、文字列）maxLength: 512
code（任意、文字列）maxLength: 8192
error（任意、文字列）maxLength：200
error_description（任意、文字列）maxLength: 2048
iss（任意、文字列）maxLength: 2048
SAMLResponse（任意、文字列）maxLength: 1048576
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/x-www-form-urlencoded' --data-binary '@request.bin' 'https://screenrig.ai/api/sso/finish'

レスポンス

ステータス意味本文とヘッダー
303セッションクッキーを設定したうえで return_to または /dashboard/ へ。サインインが完了しなかった場合は /dashboard/#sso_error=<code> へ。本文なし；ヘッダー：Location、Cache-Control、Set-Cookie
デフォルト

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

問題 (application/problem+json)
POST/api/session/sso-starts

ダッシュボードセッションSSOを開始

サインイン中のユーザーのシングルサインオンによるサインインを開始し、POST /api/sso/starts がアドレスに対して行うのと同様に、IDプロバイダーのアドレスを返します。__Host-screenrig-sso クッキーも設定します。intent が renew の場合は、シングルサインオンでサインインしたセッションを、24 時間が終わる前にサイレントで（prompt none）更新します。ダッシュボードは 12 時間経過した時点で一度これを行います。intent が reauth の場合は、プロバイダーにユーザーを再度認証させ（prompt login）、sso 証明に必要な直近のサインインをセッションに与えます。intent が link の場合は、プロバイダーにおけるユーザーのアイデンティティを既存のアカウントに関連付けます。renew と reauth にはシングルサインオンでサインインしたセッションが必要で、link にはユーザーの検証済みドメインに有効な接続が必要です。それ以外の場合は resource_conflict が返ります。return_to は /dashboard/ 配下のパスです。

認証
dashboardSession
リクエスト本文
SessionSSOStartRequest
操作ID
startDashboardSessionSSO

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

フィールド説明
intent（必須、文字列）

renew：シングルサインオンのセッションをサイレントで更新します。reauth：sso 証明のために、ユーザーを再度認証します。link：プロバイダーにおけるユーザーのアイデンティティを、そのアカウントに関連付けます。許可："renew"、"reauth"、"link"

return_to（任意、文字列）戻り先となる /dashboard/ 配下のパス。省略すると /dashboard/ に戻ります。minLength: 1 maxLength: 512 pattern: "^/dashboard/"
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/session/sso-starts'

レスポンス

ステータス意味本文とヘッダー
200遷移先のIDプロバイダーのアドレスと、トランザクションクッキー。SSOStart（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)
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)
GET/api/organizations/{org_id}/identity-provider

ダッシュボード 組織 IDプロバイダー取得

指定された管理者は、組織のシングルサインオン接続を読み取ります。内容は、プロトコルとプロバイダー、IDプロバイダーに入力するサービスプロバイダーの値（OIDC リダイレクト URI、SAML エンティティ ID、アサーションコンシューマーサービスとメタデータのアドレス）、サインインポリシー、直近のテスト結果です。

クライアントシークレットは返されません。client_secret_set は、シークレットが保存されているかどうかを示します。ready_to_require は、組織が検証済みドメインを保持し、接続の現在のアイデンティティ（発行者、テナント、エンティティ ID、kind）でテストまたは実際のサインインが成功した時点で true になります。Require SSO は、これが true の間のみ受け付けられます。ETag はリビジョンを表します。

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

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

パラメーター

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

レスポンス

ステータス意味本文とヘッダー
200組織の接続。IdentityProvider（application/json）；ヘッダー：Cache-Control、ETag
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)
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)
PUT/api/organizations/{org_id}/identity-provider

ダッシュボード 組織 IDプロバイダー設定

指定された管理者が組織の接続を作成または変更します。組織が持てる接続は 1 つです。

If-Match には GET で取得した接続のリビジョンを指定し、組織に接続がない場合は 0 を指定します。この指定は必須で、古い値は current_revision を伴う revision_conflict です。201 は作成、200 は変更を表します。proof は必須で、組織 ID を subject_id とする kind が identity_provider_change の再認証に紐付いた新しいパスキーまたはパスワードの証明、あるいは 10 分以内にシングルサインオンでサインインしたセッションによる {type: sso} です（それ以外は reauthentication_required）。

preset が entra の OIDC は tenant_id を受け取り、そこから発行者を構成します。preset が generic の場合は issuer を受け取ります。oidc.client_secret を省略すると保存済みのシークレットが維持されます。

SAML では、metadata_xml からIDプロバイダーのエンティティ ID、サインインのアドレス、署名証明書を読み取ります。idp_entity_id、idp_sso_url、certificates_pem でこれらを直接指定することもできます。certificates_pem は保存済みのリストを置き換えます。リストには最大 4 件を保持でき、ローテーション中は新しい証明書が古い証明書と重なる形で使えます。

Require SSO が有効な間は、アイデンティティ（発行者、テナント、エンティティ ID、kind）の変更は resource_conflict となり、証明書とクライアントシークレットのローテーションは許可されます。有効でない場合は、アイデンティティを変更すると、テストまたはサインインが成功するまで ready_to_require が false になります。接続を ETag とともに返します。ユーザーのみが対象です。エージェントとベアラー認証情報にはルートがありません。

最初の接続の作成（If-Match 0）はシングルサインオンであり、Enterprise プランに含まれます。プランにこの機能が含まれていない組織は feature_not_in_plan（402）で拒否されます。

すでにある接続の変更（証明書やクライアントシークレットのローテーション、メタデータの更新など）、接続の読み取り、テスト、削除は、すべてのプランで利用でき、すでにある接続はユーザーのサインインを続けます。

認証
dashboardSession
リクエスト本文
IdentityProviderWrite
操作ID
dashboardOrganizationsSetIdentityProvider

パラメーター

名前送信する必須？説明
org_idパス必須
If-Matchヘッダー必須GET で取得した接続のリビジョン（引用符付きでも可）。作成する場合は 0。

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

フィールド説明
種類（必須、文字列）許可："oidc"、"saml"
preset（必須、文字列）許可："entra"、"generic"
name（必須、文字列）minLength: 1 maxLength: 80
jit（任意、ブール値）そのアドレスを持つユーザーがいない場合に、最初のサインインでユーザーを作成します。省略すると保存済みの値が維持され、新しい接続では true になります。
oidc（任意、IdentityProviderOIDCWrite）
saml（任意、IdentityProviderSAMLWrite）
proof（必須、DashboardProof）
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/identity-provider'

レスポンス

ステータス意味本文とヘッダー
200変更後の接続。IdentityProvider（application/json）；ヘッダー：Cache-Control、ETag
201新しい接続。IdentityProvider（application/json）；ヘッダー：Cache-Control、ETag
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)
402feature_not_in_plan — シングルサインオンは Enterprise プランに含まれます。問題には、機能、アカウントのプラン、required_plan が示されます。問題 (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)
412revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。問題 (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/organizations/{org_id}/identity-provider

ダッシュボード 組織 IDプロバイダー削除

指定された管理者は、新しい証明を示したうえで組織の接続を削除します（PUT と同様に、本文に proof を含めます）。Require SSO が有効な間は、削除の予約中も含めて resource_conflict となり、組織に接続がない場合は not_found です。ユーザーのみが対象です。エージェントとベアラー認証情報にはルートがありません。

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

パラメーター

名前送信する必須？説明
org_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/organizations/ORG_ID/identity-provider'

レスポンス

ステータス意味本文とヘッダー
204接続は削除されました。本文なし
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)
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)
デフォルト

安定した 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}/identity-provider/tests

ダッシュボード 組織 IDプロバイダーテスト

指定された管理者は、必須にする前に動作を確認するため、組織の接続を通じてテストサインインを開始します。ページが遷移するIDプロバイダーのアドレスを返し、__Host-screenrig-sso クッキーを設定します。

プロバイダーの応答は /api/sso/finish で終了します。ここで結果が接続に記録され（last_test。成功すると ready_to_require が true になれます）、ブラウザーはダッシュボードに戻されます。テストは誰もサインインさせません。接続がない組織は not_found です。ユーザーのみが対象です。エージェントとベアラー認証情報にはルートがありません。

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

パラメーター

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

レスポンス

ステータス意味本文とヘッダー
200遷移先のIDプロバイダーのアドレスと、トランザクションクッキー。SSOTestStart（application/json）；ヘッダー：Cache-Control、Set-Cookie
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)
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)
PUT/api/organizations/{org_id}/sso-policy

ダッシュボード 組織 SSOポリシー設定

指定された管理者は Require SSO のオン・オフを切り替え、ブレークグラス管理者を指定します。required が true の場合、組織の検証済みドメインでのパスワードとパスキーによるサインインが拒否され（sso_required）、検証済みドメインと接続の ready_to_require が必要で、満たさない場合は resource_conflict です。この操作で policy_revision が加算されます。required が false の場合、要件はすぐには解除されません。リクエストの 72 時間後に解除が予約され（enforcement_ends_at）、すべての管理者にメールが送信され、DELETE .../sso-policy/removal で取り消せます。break_glass_user_ids にはパスキーを持つ指定された管理者を最大 2 人まで指定でき、超えると invalid_request です。この管理者は SSO が必須の間もパスキーでサインインでき、そのサインインはすべて監査されます。

If-Match には policy_revision を指定する必要があります。古い値は current_revision を伴う revision_conflict です。proof は必須で、組織 ID を subject_id とする kind が sso_policy_change の再認証に紐付いた新しいパスキーまたはパスワードの証明、あるいは 10 分以内にシングルサインオンでサインインしたセッションによる {type: sso} です。

ポリシーを ETag とともに返します。ユーザーのみが対象です。エージェントとベアラー認証情報にはルートがありません。required を true に設定することはシングルサインオンであり、Enterprise プランに含まれます。プランにこの機能が含まれていない組織は feature_not_in_plan（402）で拒否されます。required が false の場合は常に受け付けられ、オンになっている Require SSO は、オフにされるまで適用され続けます。

認証
dashboardSession
リクエスト本文
SSOPolicyWrite
操作ID
dashboardOrganizationsSetSSOPolicy

パラメーター

名前送信する必須？説明
org_idパス必須
If-Matchヘッダー必須GET identity-provider で取得した policy_revision（引用符付きでも可）。

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

フィールド説明
required（必須、ブール値）true はシングルサインオンを必須にします。false はリクエストの 72 時間後に解除を予約し、すべての管理者にメールを送信します。
break_glass_user_ids（必須、配列）パスキーを持つ指定された管理者を最大 2 人。このリストが保存済みのリストを置き換えます。
proof（必須、DashboardProof）
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/sso-policy'

レスポンス

ステータス意味本文とヘッダー
200現在適用中のポリシーです。SSOPolicy（application/json）；ヘッダー：Cache-Control、ETag
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)
402feature_not_in_plan — シングルサインオンは Enterprise プランに含まれます。問題には、機能、アカウントのプラン、required_plan が示されます。問題 (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)
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)
412revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。問題 (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/organizations/{org_id}/sso-policy/removal

ダッシュボード 組織 SSO削除のキャンセル

指定された管理者であれば誰でも、予約された Require SSO の解除を取り消せます。取り消すと Require SSO は有効なままになります。解除が予約されていない場合は何も変わりません。ポリシーを返します。ユーザーのみが対象です。エージェントとベアラー認証情報にはルートがありません。

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

パラメーター

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

レスポンス

ステータス意味本文とヘッダー
200現在適用中のポリシーです。SSOPolicy（application/json）；ヘッダー：Cache-Control、ETag
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)
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)