华为云用户手册

响应示例 状态码： 201 Successful { "id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "externalId" : "123456", "meta" : { "resourceType" : "User", "created" : "2023-04-08T14:53:43Z", "lastModified" : "2023-04-16T21:32:55Z" }, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "userName" : "xxx", "name" : { "formatted" : "xxx", "familyName" : "xxx", "givenName" : "xxx", "middleName" : "xxx", "honorificPrefix" : "xxx", "honorificSuffix" : "xxx" }, "displayName" : "xxx", "nickName" : "xxx", "title" : "xxx", "userType" : "xxx", "preferredLanguage" : "zh-CN", "locale" : "zh-CN", "timezone" : "xxx", "active" : true, "emails" : [ { "value" : "xxx", "type" : "work", "primary" : true } ], "addresses" : [ { "formatted" : "xxx", "streetAddress" : "xxx", "locality" : "xxx", "region" : "xxx", "postalCode" : "123456", "country" : "xxx", "type" : "work", "primary" : true } ], "phoneNumbers" : [ { "value" : "xxx", "type" : "work", "primary" : true } ] }

响应参数 状态码： 200 表10 响应Body参数 参数 参数类型 描述 id String 用户的全局唯一标识符（ID）。 externalId String 外部标识符。 meta Object 元数据。 schemas Array of strings 概要。 userName String 用户名，用于标识用户的唯一字符串。 name Object 包含用户姓名信息的对象。 displayName String 包含用户显示名称的字符串。 nickName String 包含用户昵称的字符串。 title String 包含用户头衔的字符串。 userType String 指示用户类型的字符串。 preferredLanguage String 包含用户首选语言的字符串。 locale String 包含用户地理区域或位置的字符串。 timezone String 包含用户时区的字符串。 active Boolean 表示用户是否启用。 emails Array of objects 包含用户的电子邮箱信息的对象列表。 addresses Array of objects 包含用户地址信息的对象列表。 phoneNumbers Array of objects 包含用户电话号码信息的对象列表。 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User Object 包含用户工作相关信息的对象。 表11 meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表12 name 参数 参数类型 描述 formatted String 包含要显示的名称的格式化版本的字符串。 familyName String 用户的姓氏。 givenName String 用户的名字。 middleName String 用户的中间名。 honorificPrefix String 用户的尊称前缀。 honorificSuffix String 用户的尊称后缀。 表13 emails 参数 参数类型 描述 value String 包含电子邮箱地址的字符串。 type String 表示电子邮箱类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主电子邮箱。 表14 addresses 参数 参数类型 描述 formatted String 包含要显示的地址的格式化版本的字符串。 streetAddress String 街道。 locality String 地址位置。 region String 区域。 postalCode String 邮政编码。 country String 国家或地区。 type String 表示地址类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主地址。 表15 phoneNumbers 参数 参数类型 描述 value String 包含电话号码的字符串。 type String 表示电话号码类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主电话号码。 表16 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 参数 参数类型 描述 costCenter String 成本中心。 最小长度：1 最大长度：1024 department String 部门。 最小长度：1 最大长度：1024 division String 分部。 最小长度：1 最大长度：1024 employeeNumber String 员工编号。 最小长度：1 最大长度：1024 manager Object 经理。 organization String 组织。 最小长度：1 最大长度：1024 表17 manager 参数 参数类型 描述 value String 经理。 最小长度：1 最大长度：1024 状态码： 400 表18 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表19 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表20 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表21 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表22 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 承载令牌。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 用户的全局唯一标识符（ID）。 externalId 否 String 外部标识符。 userName 否 String 用户名，用于标识用户的唯一字符串。 name 否 Object 包含用户姓名信息的对象。 displayName 否 String 包含用户显示名称的字符串。 nickName 否 String 包含用户昵称的字符串。 profileUrl 否 String 包含可能与用户关联的URL的字符串。 emails 否 Array of objects 包含用户的电子邮箱信息的对象列表。 addresses 否 Array of objects 包含用户地址信息的对象列表。 phoneNumbers 否 Array of objects 包含用户电话号码信息的对象列表。 userType 否 String 指示用户类型的字符串。 title 否 String 包含用户头衔的字符串。 preferredLanguage 否 String 包含用户首选语言的字符串。 locale 否 String 包含用户地理区域或位置的字符串。 timezone 否 String 包含用户时区的字符串。 active 否 Boolean 表示用户是否启用。 schemas 否 Array of strings 概要。 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 否 Object 包含用户工作相关信息的对象。 表4 name 参数 是否必选 参数类型 描述 formatted 否 String 包含要显示的名称的格式化版本的字符串。 familyName 否 String 用户的姓氏。 givenName 否 String 用户的名字。 middleName 否 String 用户的中间名。 honorificPrefix 否 String 用户的尊称前缀。 honorificSuffix 否 String 用户的尊称后缀。 表5 emails 参数 是否必选 参数类型 描述 value 是 String 包含电子邮箱地址的字符串。 type 否 String 表示电子邮箱类型的字符串。 primary 是 Boolean 一个布尔值，表示这是否为用户的主电子邮箱。 表6 addresses 参数 是否必选 参数类型 描述 formatted 否 String 包含要显示的地址的格式化版本的字符串。 streetAddress 否 String 街道。 locality 否 String 地址位置。 region 否 String 区域。 postalCode 否 String 邮政编码。 country 否 String 国家或地区。 type 否 String 表示地址类型的字符串。 primary 否 Boolean 一个布尔值，表示这是否为用户的主地址。 表7 phoneNumbers 参数 是否必选 参数类型 描述 value 否 String 包含电话号码的字符串。 type 否 String 表示电话号码类型的字符串。 primary 否 Boolean 一个布尔值，表示这是否为用户的主电话号码。 表8 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 参数 是否必选 参数类型 描述 costCenter 否 String 成本中心。 最小长度：1 最大长度：1024 department 否 String 部门。 最小长度：1 最大长度：1024 division 否 String 分部。 最小长度：1 最大长度：1024 employeeNumber 否 String 员工编号。 最小长度：1 最大长度：1024 manager 否 Object 经理。 organization 否 String 组织。 最小长度：1 最大长度：1024 表9 manager 参数 是否必选 参数类型 描述 value 否 String 经理。 最小长度：1 最大长度：1024

响应示例 状态码： 200 Successful { "id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "externalId" : "123456", "meta" : { "resourceType" : "User", "created" : "2023-04-08T14:53:43Z", "lastModified" : "2023-04-16T21:32:55Z" }, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "userName" : "xxx", "name" : { "formatted" : "xxx", "familyName" : "xxx", "givenName" : "xxx", "middleName" : "xxx", "honorificPrefix" : "xxx", "honorificSuffix" : "xxx" }, "displayName" : "xxx", "nickName" : "xxx", "title" : "xxx", "userType" : "xxx", "preferredLanguage" : "zh-CN", "locale" : "zh-CN", "timezone" : "xxx", "active" : false, "emails" : [ { "value" : "xxx", "type" : "work", "primary" : true } ], "addresses" : [ { "formatted" : "xxx", "streetAddress" : "xxx", "locality" : "xxx", "region" : "xxx", "postalCode" : "123456", "country" : "xxx", "type" : "xxx", "primary" : true } ], "phoneNumbers" : [ { "value" : "xxx", "type" : "work", "primary" : true } ] }

请求示例 修改现有用户的部分属性。 PATCH https://{hostname}/{tenant_id}/scim/v2/Users/{user_id} { "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations" : [ { "op" : "replace", "path" : "active", "value" : "false" } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 id String 用户的全局唯一标识符（ID）。 externalId String 外部标识符。 meta Object 元数据。 schemas Array of strings 概要。 userName String 用户名，用于标识用户的唯一字符串。 name Object 包含用户姓名信息的对象。 displayName String 包含用户显示名称的字符串。 nickName String 包含用户昵称的字符串。 title String 包含用户头衔的字符串。 userType String 指示用户类型的字符串。 preferredLanguage String 包含用户首选语言的字符串。 locale String 包含用户地理区域或位置的字符串。 timezone String 包含用户时区的字符串。 active Boolean 表示用户是否启用。 emails Array of objects 包含用户的电子邮箱信息的对象列表。 addresses Array of objects 包含用户地址信息的对象列表。 phoneNumbers Array of objects 包含用户电话号码信息的对象列表。 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User Object 包含用户工作相关信息的对象。 表6 meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表7 name 参数 参数类型 描述 formatted String 包含要显示的名称的格式化版本的字符串。 familyName String 用户的姓氏。 givenName String 用户的名字。 middleName String 用户的中间名。 honorificPrefix String 用户的尊称前缀。 honorificSuffix String 用户的尊称后缀。 表8 emails 参数 参数类型 描述 value String 包含电子邮箱地址的字符串。 type String 表示电子邮箱类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主电子邮箱。 表9 addresses 参数 参数类型 描述 formatted String 包含要显示的地址的格式化版本的字符串。 streetAddress String 街道。 locality String 地址位置。 region String 区域。 postalCode String 邮政编码。 country String 国家或地区。 type String 表示地址类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主地址。 表10 phoneNumbers 参数 参数类型 描述 value String 包含电话号码的字符串。 type String 表示电话号码类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主电话号码。 表11 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 参数 参数类型 描述 costCenter String 成本中心。 最小长度：1 最大长度：1024 department String 部门。 最小长度：1 最大长度：1024 division String 分部。 最小长度：1 最大长度：1024 employeeNumber String 员工编号。 最小长度：1 最大长度：1024 manager Object 经理。 organization String 组织。 最小长度：1 最大长度：1024 表12 manager 参数 参数类型 描述 value String 经理。 最小长度：1 最大长度：1024 状态码： 400 表13 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表14 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表15 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表16 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表17 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 承载令牌。 表3 请求Body参数 参数 是否必选 参数类型 描述 schemas 否 Array of strings 概要。 Operations 否 Array of objects 要执行的修改操作列表。 表4 Operations 参数 是否必选 参数类型 描述 op 否 String 要执行的修改操作类型。 add：添加属性，replace：替换属性，remove：删除属性。 path 否 String 要修改的属性路径。只有用户的以下属性可以修改： userName，active，externalId，displayName，nickName，title，userType，preferredLanguage，locale，timezone，name，enterprise，emails，addresses，phoneNumbers。 value 否 String 要修改的属性值。执行删除操作时无需填写。

请求示例 更新用户组的部分属性。 PATCH https://{hostname}/{tenant_id}/scim/v2/Groups/{group_id} { "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations" : [ { "op" : "replace", "value" : { "id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a", "displayName" : "更新显示名称" } }, { "op" : "add", "path" : "members", "value" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9" } ] }, { "op" : "replace", "path" : "members", "value" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9" }, { "value" : "1bdaa75c-7aaf-3aa2-7aac-6a00aaaa335f" } ] }, { "op" : "remove", "path" : "members", "value" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9" }, { "value" : "1bdaa75c-7aaf-3aa2-7aac-6a00aaaa335f" } ] } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 承载令牌。 表3 请求Body参数 参数 是否必选 参数类型 描述 schemas 否 Array of strings 概要。 Operations 否 Array of objects 要执行的修改操作列表。 表4 Operations 参数 是否必选 参数类型 描述 op 是 String 要执行的修改操作类型。 add：添加属性，replace：替换属性，remove：删除属性。 value 是 Object 要修改的属性值。 path 否 String 要修改的属性路径。只有用户组的以下属性可以修改： displayName，members。

响应参数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表8 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

响应示例 状态码： 200 Successful { "totalResults" : 1, "itemsPerPage" : 10, "startIndex" : "649040aaaaaaaaaaaa3e3050", "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "Resources" : [ { "id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "externalId" : "123456", "meta" : { "resourceType" : "User", "created" : "2023-04-08T14:53:43Z", "lastModified" : "2023-04-08T14:53:43Z" }, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "userName" : "xxx", "name" : { "formatted" : "xxx", "familyName" : "xxx", "givenName" : "xxx", "middleName" : "xxx", "honorificPrefix" : "xxx", "honorificSuffix" : "xxx" }, "displayName" : "xxx", "active" : true, "emails" : [ { "value" : "xxx", "type" : "work", "primary" : true } ], "userType" : "xxx" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 totalResults Integer 总结果数。 itemsPerPage String 每页的元素个数。 startIndex String 起始索引。 schemas Array of strings 概要。 Resources Array of objects 包含用户信息的列表。 表4 Resources 参数 参数类型 描述 id String 用户的全局唯一标识符（ID）。 externalId String 外部标识符。 meta Object 元数据。 schemas Array of strings 概要。 userName String 用户名，用于标识用户的唯一字符串。 name Object 包含用户姓名信息的对象。 displayName String 包含用户显示名称的字符串。 active Boolean 表示用户是否启用。 emails Array of objects 包含用户的电子邮箱信息的对象列表。 userType String 指示用户类型的字符串。 nickName String 用户昵称。 最小长度：1 最大长度：1024 title String 用户头衔。 最小长度：1 最大长度：1024 preferredLanguage String 用户语言首选项。 最小长度：1 最大长度：1024 locale String 用户的地理区域或位置信息。 最小长度：1 最大长度：1024 timezone String 用户时区。 最小长度：1 最大长度：1024 addresses Array of objects 用户的地址信息列表。 数组长度：1-1 phoneNumbers Array of objects 用户的电话号码信息列表。 数组长度：1-1 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User Object 包含用户工作相关信息的对象。 表5 Resources.meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表6 Resources.name 参数 参数类型 描述 formatted String 包含要显示的名称的格式化版本的字符串。 familyName String 用户的姓氏。 givenName String 用户的名字。 middleName String 用户的中间名。 honorificPrefix String 用户的尊称前缀。 honorificSuffix String 用户的尊称后缀。 表7 Resources.emails 参数 参数类型 描述 value String 包含电子邮箱地址的字符串。 type String 表示电子邮箱类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主电子邮箱。 表8 users.addresses 参数 参数类型 描述 formatted String 包含要显示的地址的格式化版本的字符串。 最小长度：1 最大长度：1024 streetAddress String 街道。 最小长度：1 最大长度：1024 locality String 地址位置。 最小长度：1 最大长度：1024 region String 区域。 最小长度：1 最大长度：1024 postalCode String 邮政编码。 最小长度：1 最大长度：1024 country String 国家/地区。 最小长度：1 最大长度：1024 type String 表示地址类型的字符串。 最小长度：1 最大长度：1024 primary Boolean 一个布尔值，表示这是否为用户的主地址。 表9 users.phoneNumbers 参数 参数类型 描述 value String 包含电话号码的字符串。 最小长度：1 最大长度：1024 type String 表示电话号码类型的字符串。 最小长度：1 最大长度：1024 primary Boolean 一个布尔值，表示这是否为用户的主电话号码。 表10 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 参数 参数类型 描述 costCenter String 成本中心。 最小长度：1 最大长度：1024 department String 部门。 最小长度：1 最大长度：1024 division String 分部。 最小长度：1 最大长度：1024 employeeNumber String 员工编号。 最小长度：1 最大长度：1024 manager Object 经理。 organization String 组织。 最小长度：1 最大长度：1024 表11 manager 参数 参数类型 描述 value String 经理。 最小长度：1 最大长度：1024 状态码： 400 表12 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表13 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表14 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表15 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表16 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

响应示例 状态码： 200 Successful { "totalResults" : 1, "itemsPerPage" : 10, "startIndex" : "649040aaaaaaaaaaaa3e3050", "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "Resources" : [ { "id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a", "meta" : { "resourceType" : "Group", "created" : "2023-04-08T14:53:43Z", "lastModified" : "2023-04-08T14:53:43Z" }, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "displayName" : "SCIM用户组名g1", "members" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "$ref" : "../Users/ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "type" : "User" } ] } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 totalResults Integer 总结果数。 itemsPerPage Integer 每页的元素个数。 startIndex String 起始索引。 schemas Array of strings 概要。 Resources Array of objects 包含用户组信息的列表。 表4 Resources 参数 参数类型 描述 id String 用户组的全局唯一标识符（ID）。 externalId String 外部标识符。 meta Object 元数据。 schemas Array of strings 概要。 displayName String 包含用户组显示名称的字符串。 members Array of objects 用户组中的成员对象列表。 表5 Resources.meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表6 Resources.members 参数 参数类型 描述 value String 成员的全局唯一标识符（ID）。 $ref String 成员的引用信息。 type String 成员类型，User：用户。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表10 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

响应示例 状态码： 200 Successful { "id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "externalId" : "123456", "meta" : { "resourceType" : "User", "created" : "2023-04-08T14:53:43Z", "lastModified" : "2023-04-08T14:53:43Z" }, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "userName" : "xxx", "name" : { "formatted" : "xxx", "familyName" : "xxx", "givenName" : "xxx", "middleName" : "xxx", "honorificPrefix" : "xxx", "honorificSuffix" : "xxx" }, "displayName" : "xxx", "active" : true, "emails" : [ { "value" : "xxx", "type" : "work", "primary" : true } ], "userType" : "xxx" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 用户的全局唯一标识符（ID）。 externalId String 外部标识符。 meta Object 元数据。 schemas Array of strings 概要。 userName String 用户名，用于标识用户的唯一字符串。 name Object 包含用户姓名信息的对象。 displayName String 包含用户显示名称的字符串。 active Boolean 表示用户是否启用。 emails Array of objects 包含用户的电子邮箱信息的对象列表。 userType String 指示用户类型的字符串。 nickName String 用户昵称。 最小长度：1 最大长度：1024 title String 用户头衔。 最小长度：1 最大长度：1024 preferredLanguage String 用户语言首选项。 最小长度：1 最大长度：1024 locale String 用户的地理区域或位置信息。 最小长度：1 最大长度：1024 timezone String 用户时区。 最小长度：1 最大长度：1024 addresses Array of objects 用户的地址信息列表。 数组长度：1-1 phoneNumbers Array of objects 用户的电话号码信息列表。 数组长度：1-1 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User Object 包含用户工作相关信息的对象。 表4 meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表5 name 参数 参数类型 描述 formatted String 包含要显示的名称的格式化版本的字符串。 familyName String 用户的姓氏。 givenName String 用户的名字。 middleName String 用户的中间名。 honorificPrefix String 用户的尊称前缀。 honorificSuffix String 用户的尊称后缀。 表6 emails 参数 参数类型 描述 value String 包含电子邮箱地址的字符串。 type String 表示电子邮箱类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主电子邮箱。 表7 users.addresses 参数 参数类型 描述 formatted String 包含要显示的地址的格式化版本的字符串。 最小长度：1 最大长度：1024 streetAddress String 街道。 最小长度：1 最大长度：1024 locality String 地址位置。 最小长度：1 最大长度：1024 region String 区域。 最小长度：1 最大长度：1024 postalCode String 邮政编码。 最小长度：1 最大长度：1024 country String 国家/地区。 最小长度：1 最大长度：1024 type String 表示地址类型的字符串。 最小长度：1 最大长度：1024 primary Boolean 一个布尔值，表示这是否为用户的主地址。 表8 users.phoneNumbers 参数 参数类型 描述 value String 包含电话号码的字符串。 最小长度：1 最大长度：1024 type String 表示电话号码类型的字符串。 最小长度：1 最大长度：1024 primary Boolean 一个布尔值，表示这是否为用户的主电话号码。 表9 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 参数 参数类型 描述 costCenter String 成本中心。 最小长度：1 最大长度：1024 department String 部门。 最小长度：1 最大长度：1024 division String 分部。 最小长度：1 最大长度：1024 employeeNumber String 员工编号。 最小长度：1 最大长度：1024 manager Object 经理。 organization String 组织。 最小长度：1 最大长度：1024 表10 manager 参数 参数类型 描述 value String 经理。 最小长度：1 最大长度：1024 状态码： 400 表11 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表12 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表13 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表14 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表15 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

响应示例 状态码： 200 Successful { "id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a", "meta" : { "resourceType" : "Group", "created" : "2023-04-08T14:53:43Z", "lastModified" : "2023-04-08T14:53:43Z" }, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "displayName" : "SCIM用户组名g1", "members" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "$ref" : "../Users/ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "type" : "User" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 用户组的全局唯一标识符（ID）。 externalId String 外部标识符 meta Object 元数据。 schemas Array of strings 概要。 displayName String 包含用户组显示名称的字符串。 members Array of objects 用户组中的成员对象列表。 表4 meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表5 members 参数 参数类型 描述 value String 成员的全局唯一标识符（ID）。 $ref String 成员的引用信息。 type String 成员类型，User：用户。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表9 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表4 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表5 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表6 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表4 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表5 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表6 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

响应示例 状态码： 201 Successful { "id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "externalId" : "123456", "meta" : { "resourceType" : "User", "created" : "2023-04-08T14:53:43Z", "lastModified" : "2023-04-08T14:53:43Z" }, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "userName" : "xxx", "name" : { "formatted" : "xxx", "familyName" : "xxx", "givenName" : "xxx", "middleName" : "xxx", "honorificPrefix" : "xxx", "honorificSuffix" : "xxx" }, "displayName" : "xxx", "nickName" : "xxx", "title" : "xxx", "userType" : "xxx", "preferredLanguage" : "zh-CN", "locale" : "zh-CN", "timezone" : "xxx", "active" : true, "emails" : [ { "value" : "xxx", "type" : "work", "primary" : true } ], "addresses" : [ { "formatted" : "xxx", "streetAddress" : "xxx", "locality" : "xxx", "region" : "xxx", "postalCode" : "123456", "country" : "xxx", "type" : "work", "primary" : true } ], "phoneNumbers" : [ { "value" : "xxx", "type" : "work", "primary" : true } ] }

请求示例 创建用户 POST https://{hostname}/{tenant_id}/scim/v2/Users { "externalId" : "123456", "userName" : "xxx", "name" : { "formatted" : "xxx", "familyName" : "xxx", "givenName" : "xxx", "middleName" : "xxx", "honorificPrefix" : "xxx", "honorificSuffix" : "xxx" }, "displayName" : "xxx", "nickName" : "xxx", "profileUrl" : "xxx", "emails" : [ { "value" : "xxx", "type" : "work", "primary" : true } ], "addresses" : [ { "formatted" : "xxx", "streetAddress" : "xxx", "locality" : "xxx", "region" : "xxx", "postalCode" : "123456", "country" : "xxx", "type" : "work", "primary" : true } ], "phoneNumbers" : [ { "value" : "xxx", "type" : "work", "primary" : true } ], "userType" : "xxx", "title" : "xxx", "preferredLanguage" : "zh-CN", "locale" : "zh-CN", "timezone" : "xxx", "active" : true, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ] }

响应参数 状态码： 201 表10 响应Body参数 参数 参数类型 描述 id String 用户的全局唯一标识符（ID）。 externalId String 外部标识符。 meta Object 元数据。 schemas Array of strings 概要。 userName String 用户名，用于标识用户的唯一字符串。 name Object 包含用户姓名信息的对象。 displayName String 包含用户显示名称的字符串。 nickName String 包含用户昵称的字符串。 title String 包含用户头衔的字符串。 userType String 指示用户类型的字符串。 preferredLanguage String 包含用户首选语言的字符串。 locale String 包含用户地理区域或位置的字符串。 timezone String 包含用户时区的字符串。 active Boolean 表示用户是否启用。 emails Array of objects 包含用户的电子邮箱信息的对象列表。 addresses Array of objects 包含用户地址信息的对象列表。 phoneNumbers Array of objects 包含用户电话号码信息的对象列表。 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User Object 包含用户工作相关信息的对象。 表11 meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表12 name 参数 参数类型 描述 formatted String 包含要显示的名称的格式化版本的字符串。 familyName String 用户的姓氏。 givenName String 用户的名字。 middleName String 用户的中间名。 honorificPrefix String 用户的尊称前缀。 honorificSuffix String 用户的尊称后缀。 表13 emails 参数 参数类型 描述 value String 包含电子邮箱地址的字符串。 type String 表示电子邮箱类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主电子邮箱。 表14 addresses 参数 参数类型 描述 formatted String 包含要显示的地址的格式化版本的字符串。 streetAddress String 街道。 locality String 地址位置。 region String 区域。 postalCode String 邮政编码。 country String 国家或地区。 type String 表示地址类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主地址。 表15 phoneNumbers 参数 参数类型 描述 value String 包含电话号码的字符串。 type String 表示电话号码类型的字符串。 primary Boolean 一个布尔值，表示这是否为用户的主电话号码。 表16 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 参数 参数类型 描述 costCenter String 成本中心。 最小长度：1 最大长度：1024 department String 部门。 最小长度：1 最大长度：1024 division String 分部。 最小长度：1 最大长度：1024 employeeNumber String 员工编号。 最小长度：1 最大长度：1024 manager Object 经理。 organization String 组织。 最小长度：1 最大长度：1024 表17 manager 参数 参数类型 描述 value String 经理。 最小长度：1 最大长度：1024 状态码： 400 表18 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表19 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表20 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表21 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表22 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 承载令牌。 表3 请求Body参数 参数 是否必选 参数类型 描述 externalId 否 String 外部标识符。 userName 否 String 用户名，用于标识用户的唯一字符串。 name 否 Object 包含用户姓名信息的对象。 displayName 否 String 包含用户显示名称的字符串。 nickName 否 String 包含用户昵称的字符串。 profileUrl 否 String 包含可能与用户关联的URL的字符串。 emails 否 Array of objects 包含用户的电子邮箱信息的对象列表。 addresses 否 Array of objects 包含用户地址信息的对象列表。 phoneNumbers 否 Array of objects 包含用户电话号码信息的对象列表。 userType 否 String 指示用户类型的字符串。 title 否 String 包含用户头衔的字符串。 preferredLanguage 否 String 包含用户首选语言的字符串。 locale 否 String 包含用户地理区域或位置的字符串。 timezone 否 String 包含用户时区的字符串。 active 否 Boolean 表示用户是否启用。 schemas 否 Array of strings 概要。 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 否 Object 包含用户工作相关信息的对象。 表4 name 参数 是否必选 参数类型 描述 formatted 否 String 包含要显示的名称的格式化版本的字符串。 familyName 否 String 用户的姓氏。 givenName 否 String 用户的名字。 middleName 否 String 用户的中间名。 honorificPrefix 否 String 用户的尊称前缀。 honorificSuffix 否 String 用户的尊称后缀。 表5 emails 参数 是否必选 参数类型 描述 value 是 String 包含电子邮箱地址的字符串。 type 否 String 表示电子邮箱类型的字符串。 primary 是 Boolean 一个布尔值，表示这是否为用户的主电子邮箱。 表6 addresses 参数 是否必选 参数类型 描述 formatted 否 String 包含要显示的地址的格式化版本的字符串。 streetAddress 否 String 街道。 locality 否 String 地址位置。 region 否 String 区域。 postalCode 否 String 邮政编码。 country 否 String 国家或地区。 type 否 String 表示地址类型的字符串。 primary 否 Boolean 一个布尔值，表示这是否为用户的主地址。 表7 phoneNumbers 参数 是否必选 参数类型 描述 value 否 String 包含电话号码的字符串。 type 否 String 表示电话号码类型的字符串。 primary 否 Boolean 一个布尔值，表示这是否为用户的主电话号码。 表8 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 参数 是否必选 参数类型 描述 costCenter 否 String 成本中心。 最小长度：1 最大长度：1024 department 否 String 部门。 最小长度：1 最大长度：1024 division 否 String 分部。 最小长度：1 最大长度：1024 employeeNumber 否 String 员工编号。 最小长度：1 最大长度：1024 manager 否 Object 经理。 organization 否 String 组织。 最小长度：1 最大长度：1024 表9 manager 参数 是否必选 参数类型 描述 value 否 String 经理。 最小长度：1 最大长度：1024

请求示例 创建用户组。 POST https://{hostname}/{tenant_id}/scim/v2/Groups { "displayName" : "SCIM用户组名g1", "members" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "$ref" : "../Users/ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "type" : "User" } ], "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:Group" ] }

响应示例 状态码： 201 Successful { "id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a", "meta" : { "resourceType" : "Group", "created" : "2023-04-08T14:53:43Z", "lastModified" : "2023-04-08T14:53:43Z" }, "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "displayName" : "SCIM用户组名g1", "members" : [ { "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "$ref" : "../Users/ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "type" : "User" } ] }

响应参数 状态码： 201 表5 响应Body参数 参数 参数类型 描述 id String 用户组的全局唯一标识符（ID）。 externalId String 外部标识符。 meta Object 元数据。 schemas Array of strings 概要。 displayName String 包含用户组显示名称的字符串。 members Array of objects 用户组中的成员对象列表。 表6 meta 参数 参数类型 描述 resourceType String 资源类型。 created String 资源创建时间。 lastModified String 资源最后更新时间。 表7 members 参数 参数类型 描述 value String 成员的全局唯一标识符（ID）。 $ref String 成员的引用信息。 type String 成员类型，User：用户。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 409 表11 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 schema String 概要。 schemas Array of strings 概要列表。 detail String 异常详情。 status Integer 状态码。 timeStamp String 时间戳。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 承载令牌。 表3 请求Body参数 参数 是否必选 参数类型 描述 externalId 否 String 外部标识符。 displayName 否 String 包含用户组显示名称的字符串。 members 否 Array of objects 用户组中的成员对象列表。 schemas 否 Array of strings 概要。 表4 members 参数 是否必选 参数类型 描述 value 是 String 成员的全局唯一标识符（ID）。 $ref 否 String 成员的引用信息。 type 否 String 成员类型，User：用户。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 client_info Object 包含客户端注册信息的对象。 表3 client_info 参数 参数类型 描述 authorization_endpoint String 客户端可以请求授权的端点。 client_id String 客户端应用唯一标识。 client_id_issued_at Long 客户端标识符和客户端密钥的注册时间。 client_secret String 为客户端生成的秘密字符串。客户端将使用此字符串在后续调用中获得服务的身份验证。 client_secret_expires_at Long 客户端标识符和客户端密钥失效的时间。 token_endpoint String 客户端可以在其中获取访问令牌的端点。 scopes Array of strings 服务器为客户端注册的作用域列表。后续授权访问令牌时，权限都应该限制在此作用域列表的子集范围内。

请求示例 向 IAM 身份中心注册客户端。 POST https://{hostname}/v1/clients { "client_name" : "exampleClient", "client_type" : "public", "token_endpoint_auth_method" : "client_secret_post", "scopes" : [ "openid" ], "grant_types" : [ "authorization_code", "urn:ietf:params:oauth:grant-type:device_code"], "response_types" : [ "code" ] }