使用说明

SCIM 2.0接口的实现遵循 RFC 7644，具体请求说明请参见 RFC文档

Endpoint 和 Region

SCIM服务对应的接入点（Endpoint）：https://cloudidentity-scim.${region}.volces.com/scim/v2/

SCIM 2.0 接口

分类	接口	支持情况	备注
/Me	无	不支持	无
/Bulk	无	不支持	无
Discovery Endpoint	/ServiceProviderConfig	支持	描述服务提供方（Service Provider）支持的 SCIM 规范特性
		/ResourceTypes	支持	用于发现 SCIM 服务提供方支持的资源类型（例如：用户 Users、用户组 Groups）
		/Schemas	支持	用于获取 SCIM 服务提供方支持的资源架构（schema）信息
/Users	GET /Users	支持	按条件查询用户信息或查询所有用户列表当不指定 filter 时，返回全量用户
		GET /Users/{id}	支持	查询指定 ID 的用户
		POST /Users	支持	创建用户
		PUT /Users/{id}	支持	替换指定 ID 的用户信息
		DELETE /Users/{id}	支持	删除指定 ID 的用户
		PATCH /Users/{id}	支持	更新指定 ID 的用户信息，支持 add（添加）、remove（移除）、replace（覆盖）
/Groups	GET /Groups	支持	按条件查询用户组信息或查询所有用户组列表当不指定 filter 时，返回全量用户组
		GET /Groups/{id}	支持	查询指定 ID 的用户组
		POST /Groups	支持	创建用户组
		PUT /Groups/{id}	支持	替换指定 ID 的用户组信息
		DELETE /Groups/{id}	支持	删除指定 ID 的用户组
		PATCH /Groups/{id}	支持	更新指定 ID 的用户组信息

Discovery Endpoint

/ServiceProviderConfig

功能描述

获取服务提供方配置

请求示例

返回示例

/ResourceTypes

功能描述

用于发现 SCIM 服务提供方支持的资源类型（例如：用户 Users、用户组 Groups）。

请求示例

返回示例

/Schemas

功能描述

用于获取 SCIM 服务提供方支持的资源架构（schema）信息。

请求示例

返回示例

/Users

GET /Users

功能描述

按条件查询用户信息或查询所有用户列表。

使用约束

filter 只支持 externalId、userName、id 过滤，且只支持 eq 和 and 操作符。

支持 SCIM 协议的分页方式，每页最多返回 100 条记录，如果记录条数大于 100（count > 100），则按 100 处理。

仅能查询由 SCIM 同步的用户

参数	参数取值说明	示例
filter	仅支持 userName、externalId、id 的 eq 和 and 表达式。	filter=Id eq 3001234662656 filter=externalId eq exid-sfji2ni3ti3 filter=userName eq test-user
startIndex	可置空，默认值为1，表示标号。	- startIndex=1
count	可置空，默认值为10，表示每页用户个数。	- count=100

请求示例

返回示例

GET /Users/{id}

功能描述

查询指定 ID 的用户

使用约束

如果 id 对应的用户不存在，则会拒绝访问

请求示例

返回示例

POST /Users

功能描述

创建用户

使用约束

如果云身份中心实例中存在同名的用户，会拒绝创建

如果云身份中心实例中存在相同 externalId 的用户，会拒绝创建

请求示例

返回示例

PUT /Users/{id}

功能描述

替换指定 ID 的用户信息

使用约束

{id}必传，修改的字段范围为 Schema 中定义的字段

如果 id 对应的用户不存在，则会拒绝访问

PUT 为覆盖原有属性

PUT 如果不传字段则不更新该字段，如果字段为空则会将该字段覆盖为空

仅能修改 SCIM 同步的用户

请求示例

返回示例

DELETE /Users/{id}

功能描述

删除指定 ID 的用户

使用约束

{id}必传

如果 id 对应的用户不存在，则会拒绝访问

仅能删除 SCIM 同步的用户

请求示例

PATCH /Users/{id}

功能描述

更新指定 ID 的用户信息

使用约束

{id}必传

如果 id 对应的用户不存在，则会拒绝访问

仅能修改 SCIM 同步的用户信息

Operation 最大支持长度为 10

Patch 支持 Add、Replace 和 Remove

请求示例

Operation 示例

/Groups

GET /Groups

功能描述

按条件查询用户组信息或查询所有用户组列表。

使用约束

filter 只支持 externalId、displayName、id 过滤，且只支持 eq 和 and 操作符。

支持 SCIM 协议的分页方式，每页最多返回 100 条记录，如果记录条数大于 100（count > 100），则按 100 处理。

仅能查询由 SCIM 同步的用户组

参数	参数取值说明	示例
filter	仅支持 displayName、externalId、id 的 eq 和 and 表达式。	filter=Id eq 30012346621521 filter=externalId eq exid-g-sfji2ni3ti3 filter=displayName eq test-group
startIndex	可置空，默认值为1，表示标号。	startIndex=1
count	可置空，默认值为10，表示每页用户组个数。	count=100

请求示例

返回示例

GET /Groups/{id}

功能描述

查询指定 ID 的用户组

使用约束

如果 id 对应的用户组不存在，则会拒绝访问

请求示例

返回示例

POST /Groups

功能描述

创建用户组

使用约束

如果云身份中心实例中存在同名的用户组，会拒绝创建

如果云身份中心实例中存在相同 externalId 的用户组，会拒绝创建

请求示例

返回示例

PUT /Groups/{id}

功能描述

替换指定 ID 的用户组信息

使用约束

{id} 必传，修改的字段范围为 Schema 中定义的字段。

如果 id 对应的用户组不存在，则会拒绝访问

PUT 为覆盖原有属性

PUT 如果不传字段则不更新该字段，如果字段为空则会将该字段覆盖为空

仅能修改 SCIM 同步的用户组

仅能添加 SCIM 同步的用户加入用户组

不会返回用户组成员列表

PUT 覆盖用户组成员时，一次 PUT 仅支持覆盖 100 个用户

请求示例

返回示例

DELETE /Groups/{id}

功能描述

删除指定 ID 的用户组

使用约束

{id}必传

如果 id 对应的用户组不存在，则会拒绝访问

仅能删除 SCIM 同步的用户组

请求示例

PATCH /Groups/{id}

功能描述

更新指定 ID 的用户组信息

使用约束

{id}必传

如果 id 对应的用户组不存在，则会拒绝访问

仅能修改 SCIM 同步的用户组信息

Operation 最大支持长度为 10

Patch 支持 Add、Replace 和 Remove

一个 Operation 仅支持传入 100 个 members

请求示例

Operation 示例

云身份中心