screenRIG
サインイン開始する

API リファレンス

ユーザープロビジョニング API

ユーザープロビジョニング：SCIM 2.0、トークン、グループの紐付け

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

OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要

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

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

ユーザープロビジョニング：SCIM 2.0、トークン、グループの紐付け

GET/api/organizations/{org_id}/scim

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

指定された管理者は、組織の SCIM プロビジョニング設定を読み取ります。内容は、有効かどうか、IDプロバイダーに入力するベース URL（API オリジン上）、シークレットを含まない有効なプロビジョニングトークン、プロビジョニング済みのユーザー数とグループ数です。ユーザーのみが対象です。エージェントとベアラー認証情報にはルートがありません。

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

パラメーター

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

レスポンス

ステータス意味本文とヘッダー
200組織の SCIM 設定。SCIMSettings（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)
403

安定した 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}/scim

ダッシュボード 組織 SCIM設定

指定された管理者は、新しい証明を示したうえで SCIM プロビジョニングを有効化または無効化します。新しい証明とは、組織 ID を subject_id とする kind が scim_change の再認証に紐付いたパスキーまたはパスワードの証明、あるいは 10 分以内にシングルサインオンでサインインしたセッションによる {type: sso} です。

無効化しても誰のアクセスも変わりません。すでにプロビジョニング済みのユーザーとグループは付与されたアクセスを維持し、/scim/v2 ルートは SCIM が再び有効になるまで 403 を返します。設定を返します。

ユーザーのみが対象です。エージェントとベアラー認証情報にはルートがありません。enabled が true の場合は SCIM プロビジョニングであり、Enterprise プランに含まれます。プランにこの機能が含まれていない組織は feature_not_in_plan（402）で拒否されます。enabled が false の場合は常に受け付けられ、SCIM が有効な組織の /scim/v2 エンドポイントは引き続き応答します。

認証
dashboardSession
リクエスト本文
SCIMSettingsWrite
操作ID
dashboardOrganizationsSetSCIM

パラメーター

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

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

フィールド説明
enabled（必須、ブール値）
proof（必須、DashboardProof）
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/scim'

レスポンス

ステータス意味本文とヘッダー
200組織の SCIM 設定。SCIMSettings（application/json）；ヘッダー：Cache-Control
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 — SCIM プロビジョニングは 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)
デフォルト

安定した 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}/scim/tokens

ダッシュボード 組織 SCIMトークン作成

指定された管理者は、新しい証明を示したうえでプロビジョニングトークンを発行します（PUT .../scim と同様）。トークンは srscim_ に base64url の 43 文字を続けたもので、ここで一度だけ返されます。サーバーは識別用に SHA-256 ダイジェストとプレフィックスを保持します。組織が保持できる有効なトークンは最大 5 つで、超えると resource_conflict です。

ユーザーのみが対象です。エージェントとベアラー認証情報にはルートがありません。トークンの発行は SCIM プロビジョニングであり、Enterprise プランに含まれます。プランにこの機能が含まれていない組織は feature_not_in_plan（402）で拒否されます。すでに発行されたトークンは引き続き使用でき、失効させることもできます。

認証
dashboardSession
リクエスト本文
SCIMTokenCreate
操作ID
dashboardOrganizationsCreateSCIMToken

パラメーター

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

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

フィールド説明
name（必須、文字列）minLength: 1 maxLength: 80
proof（必須、DashboardProof）
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
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/scim/tokens'

レスポンス

ステータス意味本文とヘッダー
201新しいトークン（シークレット付き）。SCIMTokenCreated（application/json）；ヘッダー：Cache-Control
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 — SCIM プロビジョニングは 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)
デフォルト

安定した 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}/scim/tokens/{token_id}

ダッシュボード 組織 SCIMトークン取り消し

指定された管理者はプロビジョニングトークンを取り消します。以後、そのトークンを提示したリクエストは 401 で拒否されます。すでに取り消されたトークンは 204 を返し、組織が保持しない ID は not_found です。ユーザーのみが対象です。エージェントとベアラー認証情報にはルートがありません。

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

パラメーター

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

レスポンス

ステータス意味本文とヘッダー
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)
デフォルト

安定した 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}/scim/groups

ダッシュボード 組織 SCIMグループ一覧

指定された管理者は、IDプロバイダーがプロビジョニングしたグループを、メンバー数と各グループが紐付けられているプロジェクトとともに一覧表示します。紐付けはプロジェクト内で、そこで承認できるユーザーが行います（createDashboardGroupBinding）。管理者に表示されるのは紐付けとプロジェクト名のみで、プロジェクトへのアクセスは付与されません。

ユーザーのみが対象です。エージェントとベアラー認証情報にはルートがありません。

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

パラメーター

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

レスポンス

ステータス意味本文とヘッダー
200組織のプロビジョニング済みグループ。SCIMGroupList（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)
403

安定した 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}/scim/events

ダッシュボード 組織 SCIMイベント一覧

指定された管理者は、組織の SCIM クライアントが送信した直近 500 件のリクエストを、失敗も含めて新しい順に読み取ります。保持期間は 30 日です。各行にはオペレーション、リソース、ステータスが示され、リクエストが失敗した場合は detail が付きます。ユーザーのみが対象です。エージェントとベアラー認証情報にはルートがありません。

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

パラメーター

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

レスポンス

ステータス意味本文とヘッダー
200組織の最新の SCIM イベント。SCIMEventList（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)
403

安定した 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/project/group-bindings

ダッシュボードのグループ紐付けを一覧表示

セッションのプロジェクトのグループ紐付けと、選択用に、組織のIDプロバイダーがプロビジョニングしたグループ（名前とメンバー数）。

紐付けは、グループのすべてのメンバーにこのプロジェクトのメンバーシップを与えます。ロールが member なら通常のメンバーシップで、approver ならレビューを承認することもでき、その範囲はプロジェクト全体、またはその紐付けの screen_scope です。プロジェクトの複数の紐付けが及ぶユーザーは、それらのスコープの和集合を持ち、スコープのない紐付けはプロジェクト全体を与えます。

ユーザーがレビューを承認できるのは、承認者の紐付けのスコープ（承認を手動で付与されている場合はそのスコープを含む）の和集合が、全体の和集合を網羅している場合だけで、そうでなければメンバーです。SCIM は手動の付与を下げることはなく、下げることになる紐付けはそのユーザーに適用されず、失敗した SCIM イベントとして記録されます。

プロジェクトのメンバーは誰でも読み取れますが、スクリーンに限定された呼び出し元は除きます（outside_screen_scope）。

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

レスポンス

ステータス意味本文とヘッダー
200プロジェクトの紐付けと、組織のグループ。GroupBindingList（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)
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/project/group-bindings

ダッシュボードのグループ紐付けを作成

プロビジョニング済みグループを、ロールと、任意で、スクリーンフォルダーとスクリーンに限定する screen_scope を指定して、セッションのプロジェクトに紐付けます（作成後は固定で、プロジェクトが保持しない ID があれば invalid_request がそのフィールドを示します）。

実行できるのはプロジェクトのオーナーまたは承認できるメンバーのみで、それ以外は approver_required です（スクリーンに限定された呼び出し元は outside_screen_scope）。プロジェクトの組織の管理者はそのようなメンバーとして紐付けを行うため、承認できない管理者は先にプロジェクトに参加します（POST /api/organizations/{org_id}/projects/{project_id}/access で承認者になります）。紐付けはその後、組織の監査に記録され、プロジェクトの監査では by_organization_admin が付与され、プロジェクトのオーナーにメールが送信されます。スタッフのシャドウセッションは読み取り専用です。

グループはプロジェクトの組織のプロビジョニング済みグループでなければならず、そうでない場合は not_found です。1つのグループをプロジェクトに紐付けられるのは1回のみで、重複すると resource_conflict です。紐付けは、グループの現在のメンバーに対してただちに有効になり、グループのメンバーシップの変更にもすべて追随します。

プロジェクトの 200 メンバーという上限が適用されます。上限により拒否されたユーザーは、組織の SCIM イベントに失敗したイベントとして記録され、他には何も変わりません。組織のゲストポリシーが受け入れない外部ゲストとなるユーザーも同様です（guest_not_allowed）。

紐付けがスコープを変更すると、project.member_screen_scope_changed が追加されます（details は user_id、screen_scope、previous、via は scim、changed_by_user_id は空）。グループを紐付けることは SCIM プロビジョニングであり、Enterprise プランに含まれます。プランにこの機能が含まれていないプロジェクトは feature_not_in_plan（402）で拒否されます。すでに存在する紐付けは引き続きアクセスを付与し、削除できます。

認証
dashboardSession
リクエスト本文
GroupBindingCreate
操作ID
createDashboardGroupBinding

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

フィールド説明
group_id（必須、文字列）minLength: 1 maxLength: 200
role（必須、文字列）許可："approver"、"member"
screen_scope（任意、ScreenScope）

スコープ付きメンバーまたはエージェントが操作できる対象（docs/screen-scope.md）：一覧のスクリーンフォルダーとその内側のすべてのフォルダーにあるスクリーン、および一覧のスクリーン。合計で少なくとも1つのID。書き込み時にプロジェクトの有効なフォルダーまたはスクリーンを指さないIDは、その位置で invalid_request です。後で削除されると、何も付与しない無効なIDが残ります。

スコープはリクエストごとに読み取られるため、変更は次のリクエストから適用されます。タグはスコープになりません。

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

レスポンス

ステータス意味本文とヘッダー
201新しい紐付け。GroupBinding（application/json）；ヘッダー：Cache-Control
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 — SCIM プロビジョニングは 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)
デフォルト

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

問題 (application/problem+json)
削除/api/project/group-bindings/{binding_id}

ダッシュボードのグループ紐付けを削除

セッションプロジェクトからグループの紐付けを解除します。実行できるのはプロジェクトのオーナーまたは承認できるメンバーのみで、それ以外は approver_required です。プロジェクトの組織の管理者はそのようなメンバーとして解除を行い、紐付けと同じ方法で記録されます。

その紐付けのみを通じてアクセスを持っていたユーザーはアクセスを失います。手動で付与したメンバーシップは残り、紐付けによって引き上げられた、または広げられた手動の付与は、スクリーンスコープも含めて元の状態に戻ります。プロジェクトが保持しない ID は not_found です。

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

パラメーター

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

レスポンス

ステータス意味本文とヘッダー
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)
GET/scim/v2/ServiceProviderConfig

SCIMサービスプロバイダー設定を取得

組織の SCIM サービスの RFC 7643 ServiceProviderConfig。patch とフィルター（結果は最大 200 件）はサポートされ、bulk、sort、etag、changePassword はサポートされません。リクエストとレスポンスは application/scim+json で、リクエストでは application/json も受け付けられます。

認証
scimBearer
リクエスト本文
なし
操作ID
getSCIMServiceProviderConfig
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/ServiceProviderConfig'

レスポンス

ステータス意味本文とヘッダー
200サービスプロバイダーの構成。SCIMResource（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
GET/scim/v2/ResourceTypes

SCIMリソースタイプを一覧表示

サービスがプロビジョニングする RFC 7643 のリソースタイプ：User と Group。

認証
scimBearer
リクエスト本文
なし
操作ID
listSCIMResourceTypes
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/ResourceTypes'

レスポンス

ステータス意味本文とヘッダー
200リソースタイプの ListResponse。SCIMResource（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
GET/scim/v2/Schemas

SCIMスキーマを一覧表示

サービスがプロビジョニングするリソースの RFC 7643 スキーマ定義。

認証
scimBearer
リクエスト本文
なし
操作ID
listSCIMSchemas
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Schemas'

レスポンス

ステータス意味本文とヘッダー
200スキーマの ListResponse。SCIMResource（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
GET/scim/v2/Users

SCIMユーザーを一覧表示

組織のプロビジョニング済みユーザーを RFC 7644 の ListResponse として一覧表示します。filter は、and で結合した 1～4 個の attr eq value 項です。値は引用符付きの JSON 文字列、または active に対する true か false です。

ユーザーは userName（大文字小文字を区別しない）、externalId（完全一致）、id、emails、emails.value、displayName、active で絞り込めます。それ以外のフィルターは 400 invalidFilter です。startIndex は 1 始まりです。count のデフォルトは 100、最大は 200 で、count=0 は totalResults のみを返します。attributes と excludedAttributes は、返される応答のメンバー（属性）を絞り込みます。

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

パラメーター

名前送信する必須？説明
filterクエリオプションand で結合した 1～4 個の attr eq value 項。値は引用符付きの JSON 文字列、または active に対する true か false です。サポートされていない属性、演算子、形式は 400 invalidFilter です。
startIndexクエリオプション最初の結果の 1 始まりのインデックス。1 未満の値は 1 として扱われます。
countクエリオプションページサイズ。最大 200 です。0 は totalResults のみを返します。それより大きい値は 200 として扱われます。
attributesクエリオプション返す属性のカンマ区切りリスト。id と schemas を除き、それ以外は除外されます。
excludedAttributesクエリオプション除外する属性のカンマ区切りリスト。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users'

レスポンス

ステータス意味本文とヘッダー
200ユーザーの ListResponse。SCIMResource（application/scim+json）
400

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
POST/scim/v2/Users

SCIMユーザーを作成

ユーザーをプロビジョニングし、リソースとその Location とともに 201 を返します。ユーザーは勤務先のメールアドレス、なければプライマリメールアドレス、それもなければ userName で識別され、そのアドレスは組織の検証済みドメインのいずれかのものである必要があります。

認証情報を持たないユーザー、または組織がすでに管理しているユーザーは、組織の管理下に入り、接続を通じてサインインします。すでに組織のプロジェクトのメンバーで、独自のサインインを維持しているユーザーは、アクセスのためだけにリンクされます。このため SCIM が管理するのは組織のプロジェクトでの付与のみで、ユーザー本人は管理しません。

組織がプロビジョニングできないアドレス（別のドメインのアドレスや screenRIG スタッフのアドレスなど）は、detail に理由を示す SCIM エラーで拒否されます。組織が管理していなかった間にこの組織がユーザーを削除したユーザーは、削除によって失われたアクセスとともに、再びプロビジョニングされます。すでにプロビジョニング済みの userName は 409 uniqueness です。

認証
scimBearer
リクエスト本文
SCIMResource
操作ID
createSCIMUser

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

フィールド説明
schemas（任意、配列）ドキュメントが従うスキーマの URN。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Users'

レスポンス

ステータス意味本文とヘッダー
201プロビジョニング済みユーザー。SCIMResource（application/scim+json）；ヘッダー：Location
400

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
409

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
GET/scim/v2/Users/{id}

SCIMユーザーを取得

プロビジョニング済みユーザーを 1 件読み取ります。attributes と excludedAttributes は、返される応答のメンバー（属性）を絞り込みます。

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

パラメーター

名前送信する必須？説明
IDパス必須プロビジョニング済みリソースの ID。SCIM サービスが返したものです。
attributesクエリオプション返す属性のカンマ区切りリスト。id と schemas を除き、それ以外は除外されます。
excludedAttributesクエリオプション除外する属性のカンマ区切りリスト。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200ユーザー。SCIMResource（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
404

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
PUT/scim/v2/Users/{id}

SCIMユーザーを置換

プロビジョニング済みユーザーを、送信されたドキュメントで置き換えます。active が false の場合、ユーザーは無効化されます。

組織が管理するユーザーは、ダッシュボードでの操作と同様に無効化されます。そのセッションとダッシュボードトークンは終了し、プロジェクトのメンバーシップと責任を負うエージェントは一時停止され、組織の最後の管理者は 400 mutability で拒否されます。active を true にすると、それらのメンバーシップとエージェントとともにユーザーが復帰します。

組織が管理していないユーザーは、組織のプロジェクトでのアクセスを失い（本人が所有するプロジェクトは対象外）、セッションが終了します。active を true にするとそのアクセスが復元されます。screenRIG スタッフを表すユーザーは変更されません（400 mutability）。

認証
scimBearer
リクエスト本文
SCIMResource
操作ID
replaceSCIMUser

パラメーター

名前送信する必須？説明
IDパス必須プロビジョニング済みリソースの ID。SCIM サービスが返したものです。

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

フィールド説明
schemas（任意、配列）ドキュメントが従うスキーマの URN。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200保存されているユーザー。SCIMResource（application/scim+json）
400

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
404

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
409

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
PATCH/scim/v2/Users/{id}

SCIMユーザーを部分更新

RFC 7644 の PatchOp メッセージをプロビジョニング済みユーザーに適用し、ユーザーとともに 200 を返します。

オペレーションは、Microsoft Entra ID と Okta が送信する形式で、?aadOptscim062020 の有無にかかわらず読み取られます。op の名前は大文字小文字を区別せず、ブール値は true か false、または "True" か "False" です。オペレーションでは path を省略することも、name.givenName のようにドットでつないだキーを使うこともできます。path には emails[type eq "work"].value、members（add、replace、および value 配列を伴う remove）、members[value eq "<id>"]（remove）が含まれます。screenRIG が使用しない属性は受け付けられ、無視されます。active を false にするとユーザーが無効化されます。

組織が管理するユーザーは、ダッシュボードでの操作と同様に無効化されます。そのセッションとダッシュボードトークンは終了し、プロジェクトのメンバーシップと責任を負うエージェントは一時停止され、組織の最後の管理者は 400 mutability で拒否されます。active を true にすると、それらのメンバーシップとエージェントとともにユーザーが復帰します。

組織が管理していないユーザーは、組織のプロジェクトでのアクセスを失い（本人が所有するプロジェクトは対象外）、セッションが終了します。active を true にするとそのアクセスが復元されます。screenRIG スタッフを表すユーザーは変更されません（400 mutability）。

認証
scimBearer
リクエスト本文
SCIMResource
操作ID
patchSCIMUser

パラメーター

名前送信する必須？説明
IDパス必須プロビジョニング済みリソースの ID。SCIM サービスが返したものです。

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

フィールド説明
schemas（任意、配列）ドキュメントが従うスキーマの URN。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PATCH --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200保存されているユーザー。SCIMResource（application/scim+json）
400

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
404

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
409

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
削除/scim/v2/Users/{id}

SCIMユーザーを削除

active false の場合と同様にユーザーを無効化します。その後、この ID は not_found になり、ユーザーはすべての一覧とフィルターから外れます。組織が管理していないユーザーについては、無効化によって削除されたアクセスが保持され、同じユーザーを後で作成すると復元されます。screenRIG スタッフを表すユーザーは変更されません（400 mutability）。

ユーザー本人を消去することはありません。消去はユーザー自身によるアカウント削除で行われます。

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

パラメーター

名前送信する必須？説明
IDパス必須プロビジョニング済みリソースの ID。SCIM サービスが返したものです。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
204ユーザーは無効化され、プロビジョニングの対象ではなくなりました。本文なし
400

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
404

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
GET/scim/v2/Groups

SCIMグループを一覧表示

組織のプロビジョニング済みグループを RFC 7644 の ListResponse として一覧表示します。filter は、and で結合した 1～4 個の attr eq value 項です。

グループは displayName、externalId、id、members、members.value で絞り込めます。それ以外のフィルターは 400 invalidFilter です。startIndex は 1 始まりです。count のデフォルトは 100、最大は 200 で、count=0 は totalResults のみを返します。attributes と excludedAttributes は、返される応答のメンバー（属性）を絞り込みます。

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

パラメーター

名前送信する必須？説明
filterクエリオプションand で結合した 1～4 個の attr eq value 項。値は引用符付きの JSON 文字列、または active に対する true か false です。サポートされていない属性、演算子、形式は 400 invalidFilter です。
startIndexクエリオプション最初の結果の 1 始まりのインデックス。1 未満の値は 1 として扱われます。
countクエリオプションページサイズ。最大 200 です。0 は totalResults のみを返します。それより大きい値は 200 として扱われます。
attributesクエリオプション返す属性のカンマ区切りリスト。id と schemas を除き、それ以外は除外されます。
excludedAttributesクエリオプション除外する属性のカンマ区切りリスト。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups'

レスポンス

ステータス意味本文とヘッダー
200グループの ListResponse。SCIMResource（application/scim+json）
400

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
POST/scim/v2/Groups

SCIMグループを作成

グループをプロビジョニングし、リソースとその Location とともに 201 を返します。displayName は組織内で一意で、大文字小文字を区別せずに比較されます。重複すると 409 uniqueness です。承認できるユーザーがダッシュボードでグループをプロジェクトに紐付けるまで、グループはアクセスを付与しません。

認証
scimBearer
リクエスト本文
SCIMResource
操作ID
createSCIMGroup

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

フィールド説明
schemas（任意、配列）ドキュメントが従うスキーマの URN。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Groups'

レスポンス

ステータス意味本文とヘッダー
201プロビジョニング済みグループ。SCIMResource（application/scim+json）；ヘッダー：Location
400

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
409

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
GET/scim/v2/Groups/{id}

SCIMグループを取得

プロビジョニング済みグループを 1 件読み取ります。attributes と excludedAttributes は、返される応答のメンバー（属性）を絞り込みます。

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

パラメーター

名前送信する必須？説明
IDパス必須プロビジョニング済みリソースの ID。SCIM サービスが返したものです。
attributesクエリオプション返す属性のカンマ区切りリスト。id と schemas を除き、それ以外は除外されます。
excludedAttributesクエリオプション除外する属性のカンマ区切りリスト。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200グループ。SCIMResource（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
404

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
PUT/scim/v2/Groups/{id}

SCIMグループを置換

プロビジョニング済みグループを、送信されたドキュメントで置き換えます。members を含まないドキュメントでは、グループのメンバーが維持されます。メンバーシップの変更は、影響を受けるユーザーのプロジェクトへのアクセスに反映されます。この処理は冪等です。

認証
scimBearer
リクエスト本文
SCIMResource
操作ID
replaceSCIMGroup

パラメーター

名前送信する必須？説明
IDパス必須プロビジョニング済みリソースの ID。SCIM サービスが返したものです。

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

フィールド説明
schemas（任意、配列）ドキュメントが従うスキーマの URN。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200保存されているグループ。SCIMResource（application/scim+json）
400

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
404

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
409

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
PATCH/scim/v2/Groups/{id}

SCIMグループを部分更新

RFC 7644 の PatchOp メッセージをプロビジョニング済みグループに適用し、204 を返します。attributes または excludedAttributes を指定した場合は、グループとともに 200 を返します。

オペレーションは、Microsoft Entra ID と Okta が送信する形式で、?aadOptscim062020 の有無にかかわらず読み取られます。op の名前は大文字小文字を区別せず、ブール値は true か false、または "True" か "False" です。オペレーションでは path を省略することも、name.givenName のようにドットでつないだキーを使うこともできます。path には emails[type eq "work"].value、members（add、replace、および value 配列を伴う remove）、members[value eq "<id>"]（remove）が含まれます。screenRIG が使用しない属性は受け付けられ、無視されます。

メンバーシップの変更は、影響を受けるユーザーのプロジェクトへのアクセスに反映されます。この処理は冪等です。

認証
scimBearer
リクエスト本文
SCIMResource
操作ID
patchSCIMGroup

パラメーター

名前送信する必須？説明
IDパス必須プロビジョニング済みリソースの ID。SCIM サービスが返したものです。
attributesクエリオプション返す属性のカンマ区切りリスト。id と schemas を除き、それ以外は除外されます。
excludedAttributesクエリオプション除外する属性のカンマ区切りリスト。

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

フィールド説明
schemas（任意、配列）ドキュメントが従うスキーマの URN。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PATCH --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200attributes または excludedAttributes を指定した場合の、保存されているグループ。SCIMResource（application/scim+json）
204パッチが適用されました。本文なし
400

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
404

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
409

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
削除/scim/v2/Groups/{id}

SCIMグループを削除

プロビジョニング済みグループを、そのプロジェクトへの紐付けとともに削除します。その紐付けのみを通じてアクセスを持っていたユーザーはアクセスを失います。手動で付与したメンバーシップは残ります。

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

パラメーター

名前送信する必須？説明
IDパス必須プロビジョニング済みリソースの ID。SCIM サービスが返したものです。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
204グループは削除されました。本文なし
401

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
403

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
404

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）
429組織のリクエスト枠（1 分あたり 600 件）を使い切りました。status が "429" の SCIM エラーです。Retry-After の間隔が過ぎてから再試行してください。SCIMError（application/scim+json）；ヘッダー：Retry-After
デフォルト

RFC 7644 セクション 3.12 の SCIM エラーで、application/scim+json です。問題ドキュメントではありません。status は HTTP ステータスを文字列として繰り返し、scimType は分類を示します（invalidFilter、uniqueness、mutability、およびその RFC のその他の値）。detail は拒否された内容を示します。401 は不明または取り消されたトークン、403 は SCIM がオフの組織です。

SCIMError（application/scim+json）