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 预配设置：是否已启用、要在身份提供者处输入的基础 URL（位于 API 源）、不含密钥的有效预配令牌，以及已预配用户和群组的数量。仅限人员；智能体和持有者凭证无路由。

身份验证
dashboardSession
请求主体
无
操作 ID
dashboardOrganizationsGetSCIM

参数

名称发送必需？描述
org_id路径必填
请求模板和响应
shell · 请求模板
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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
403

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
PUT/api/organizations/{org_id}/scim

控制台组织设置 SCIM

指定管理员在提供新的证明后启用或禁用 SCIM 预配：证明为绑定到类型为 scim_change、以组织 id 作为 subject_id 的重新认证的通行密钥或密码证明，或来自 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路径必填

请求主体字段

字段描述
启用（必填，布尔值）
proof（必填，DashboardProof）
请求模板和响应
shell · 请求模板
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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
401

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
POST/api/organizations/{org_id}/scim/tokens

控制台组织创建 SCIM 令牌

指定管理员在提供新的证明后（与 PUT .../scim 相同）生成预配令牌。令牌由 srscim_ 加 43 个 base64url 字符组成，仅在此处返回一次；服务器保留 SHA-256 摘要和用于识别它的前缀。一个组织最多持有 5 个有效令牌，否则返回 resource_conflict。

仅限人员；智能体和持有者凭证无路由。签发令牌属于 SCIM 预配，Enterprise 计划包含该功能；计划不含该功能的组织会被拒绝并返回 feature_not_in_plan（402）。已签发的令牌继续有效，并且可以撤销。

身份验证
dashboardSession
请求主体
SCIMTokenCreate
操作 ID
dashboardOrganizationsCreateSCIMToken

参数

名称发送必需？描述
org_id路径必填

请求主体字段

字段描述
名称（必填，字符串）minLength：1 maxLength：80
proof（必填，DashboardProof）
请求模板和响应
shell · 请求模板
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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
401

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
409

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，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路径必填
请求模板和响应
shell · 请求模板
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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
403

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
404

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
GET/api/organizations/{org_id}/scim/groups

控制台组织列出 SCIM 群组

指定管理员列出身份提供者已预配的群组，包括其成员数以及各群组所绑定的项目。绑定在项目中由可在该项目审批的人员完成（createDashboardGroupBinding）；管理员只能看到绑定和项目名称，这不授予任何项目访问权限。

仅限人员；智能体和持有者凭证无路由。

身份验证
dashboardSession
请求主体
无
操作 ID
dashboardOrganizationsListSCIMGroups

参数

名称发送必需？描述
org_id路径必填
请求模板和响应
shell · 请求模板
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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
403

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，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路径必填
请求模板和响应
shell · 请求模板
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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
403

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
GET/api/project/group-bindings

列出控制台群组绑定

会话项目的群组绑定，以及其组织的身份提供者已预配、可供选择的群组（名称和成员数）。

绑定会让群组的每位成员在此项目中获得成员资格：角色 member 是普通成员资格，角色 approver 还允许该人员审批审核，范围为整个项目或该绑定的 screen_scope。受项目的多个绑定影响的人员持有它们范围的并集，没有范围的绑定会授予整个项目。

只有当此人的批准人绑定范围（连同手动授予的批准权限的范围）的并集覆盖了全部范围的并集时，此人才能审批审核，否则只是成员；SCIM 绝不会降低手动授权：会造成降低的绑定不会应用到此人，并记录为一次失败的 SCIM 事件。

项目的任何成员都可以读取，但限定于屏幕的调用方除外（outside_screen_scope）。

身份验证
dashboardSession
请求主体
无
操作 ID
listDashboardGroupBindings
请求模板和响应
shell · 请求模板
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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
409

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
POST/api/project/group-bindings

创建控制台群组绑定

将已预配的群组绑定到会话项目，需指定角色，并可选指定 screen_scope 将其限定在屏幕文件夹和屏幕（创建后固定；invalid_request 会指出项目不持有的 id 所在的字段）。

仅限项目所有者或可批准的成员（否则返回 approver_required；限定于屏幕的调用方返回 outside_screen_scope）；项目所属组织的管理员以此类成员身份进行绑定，因此无法批准的管理员须先加入项目（POST /api/organizations/{org_id}/projects/{project_id}/access 使其成为审批人），随后该绑定会记录在组织审计中，在项目审计中标记为 by_organization_admin，并向项目所有者发送电子邮件；员工影子会话为只读。

该群组必须是项目所属组织的已预配群组之一，否则返回 not_found；一个群组只能绑定到同一项目一次，否则返回 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）：所列屏幕文件夹及其内部每个文件夹中的屏幕，以及所列屏幕。所有 ID 中至少一个。写入时不指向项目现存文件夹或屏幕的 ID，在其位置为 invalid_request；之后的删除会留下不授予任何权限的无效 ID。

范围在每次请求时读取，因此更改会在下一次请求时生效。标签永远不是范围。

请求模板和响应
shell · 请求模板
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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
401

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
404

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
409

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，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路径必填
请求模板和响应
shell · 请求模板
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 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
403

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
404

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
409

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
默认

稳定的 RFC 9457 问题响应。421 server_draining 携带 1 秒的 Retry-After，500 not_ready 或 dependency_unavailable 携带 5 秒，500 manifest_degraded 携带 60 秒，除非处理程序设置了更具体的值。

问题 (application/problem+json)
GET/scim/v2/ServiceProviderConfig

获取 SCIM ServiceProviderConfig

组织 SCIM 服务的 RFC 7643 ServiceProviderConfig：支持 patch 和 filter（最多 200 个结果）；不支持 bulk、sort、etag 和 changePassword。请求和响应为 application/scim+json；请求也接受 application/json。

身份验证
scimBearer
请求主体
无
操作 ID
getSCIMServiceProviderConfig
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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 schema

该服务预配的资源的 RFC 7643 schema 定义。

身份验证
scimBearer
请求主体
无
操作 ID
listSCIMSchemas
请求模板和响应
shell · 请求模板
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Schemas'

响应

状态含义正文和头部
200Schema 的 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组织的请求预算（每分钟 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 连接的 attr eq value 项；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 连接的 attr eq value 项。value 为带引号的 JSON 字符串，对 active 则为 true 或 false。不受支持的属性、运算符或形式返回 400 invalidFilter。
startIndex查询可选第一个结果的索引，从 1 开始。小于 1 的值按 1 处理。
count查询可选页面大小，最大为 200。0 仅返回 totalResults。更大的值按 200 处理。
attributes查询可选以逗号分隔的、要返回的属性列表；其余属性被省略，id 和 schemas 除外。
excludedAttributes查询可选以逗号分隔的、要省略的属性列表。
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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 用户

预配一个用户并返回 201，附带资源及其 Location。人员依次通过其工作电子邮件、主电子邮件、userName 来识别，且该地址必须位于组织的某个已验证域名下。

没有任何凭证，或已由该组织管理的人员，会由它管理并通过该连接登录；已是其某个项目的成员且保留自己登录方式的人员仅为访问而关联，因此 SCIM 管理的是其在组织项目中的授权，而不是这个人本身。

组织不得预配的地址，例如位于其他域名的地址或 screenRIG 员工的地址，会被拒绝并返回 SCIM 错误，其 detail 指明原因。组织在不管理某人员时删除了其用户，该人员会被再次预配，并恢复该删除所移除的访问权限。已预配的 userName 返回 409 uniqueness。

身份验证
scimBearer
请求主体
SCIMResource
操作 ID
createSCIMUser

请求主体字段

字段描述
schemas（可选，数组）文档遵循的 schema 的 URN。
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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 用户

读取一个已预配的用户。attributes 和 excludedAttributes 用于裁剪返回的成员。

身份验证
scimBearer
请求主体
无
操作 ID
getSCIMUser

参数

名称发送必需？描述
id路径必填已预配资源的 id，与 SCIM 服务返回的一致。
attributes查询可选以逗号分隔的、要返回的属性列表；其余属性被省略，id 和 schemas 除外。
excludedAttributes查询可选以逗号分隔的、要省略的属性列表。
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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（可选，数组）文档遵循的 schema 的 URN。
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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；路径包括 emails[type eq "work"].value、members（add、replace，以及带值数组的 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（可选，数组）文档遵循的 schema 的 URN。
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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 服务返回的一致。
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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 连接的 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 连接的 attr eq value 项。value 为带引号的 JSON 字符串，对 active 则为 true 或 false。不受支持的属性、运算符或形式返回 400 invalidFilter。
startIndex查询可选第一个结果的索引，从 1 开始。小于 1 的值按 1 处理。
count查询可选页面大小，最大为 200。0 仅返回 totalResults。更大的值按 200 处理。
attributes查询可选以逗号分隔的、要返回的属性列表；其余属性被省略，id 和 schemas 除外。
excludedAttributes查询可选以逗号分隔的、要省略的属性列表。
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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 群组

预配一个群组并返回 201，附带资源及其 Location。displayName 在组织内唯一，比较时不区分大小写；重复值返回 409 uniqueness。在可审批的人员于控制台中将群组绑定到项目之前，群组不授予任何访问权限。

身份验证
scimBearer
请求主体
SCIMResource
操作 ID
createSCIMGroup

请求主体字段

字段描述
schemas（可选，数组）文档遵循的 schema 的 URN。
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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 群组

读取一个已预配的群组。attributes 和 excludedAttributes 用于裁剪返回的成员。

身份验证
scimBearer
请求主体
无
操作 ID
getSCIMGroup

参数

名称发送必需？描述
id路径必填已预配资源的 id，与 SCIM 服务返回的一致。
attributes查询可选以逗号分隔的、要返回的属性列表；其余属性被省略，id 和 schemas 除外。
excludedAttributes查询可选以逗号分隔的、要省略的属性列表。
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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（可选，数组）文档遵循的 schema 的 URN。
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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；路径包括 emails[type eq "work"].value、members（add、replace，以及带值数组的 remove）和 members[value eq "<id>"]（remove）；screenRIG 不使用的属性会被接受并忽略。

成员资格变更会协调受影响人员的项目访问，该操作是幂等的。

身份验证
scimBearer
请求主体
SCIMResource
操作 ID
patchSCIMGroup

参数

名称发送必需？描述
id路径必填已预配资源的 id，与 SCIM 服务返回的一致。
attributes查询可选以逗号分隔的、要返回的属性列表；其余属性被省略，id 和 schemas 除外。
excludedAttributes查询可选以逗号分隔的、要省略的属性列表。

请求主体字段

字段描述
schemas（可选，数组）文档遵循的 schema 的 URN。
请求模板和响应
shell · 请求模板
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'

响应

状态含义正文和头部
200给出 attributes 或 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组织的请求预算（每分钟 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 服务返回的一致。
请求模板和响应
shell · 请求模板
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组织的请求预算（每分钟 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）