华为云用户手册

请求示例 根据用户ID，更新对应 IAM 身份中心用户的属性。 PUT https://{hostname}/v1/identity-stores/{identity_store_id}/users/{user_id} { "operations" : [ { "attribute_path" : "emails", "attribute_value" : "[{\"primary\":true,\"type\":\"Work\",\"value\":\"new-email@example.com\"}]" }, { "attribute_path" : "name", "attribute_value" : "{\"family_name\":\"姓氏\",\"given_name\":\"名字-new\"}" }, { "attribute_path" : "display_name", "attribute_value" : "用户显示名-new" } ] }

响应参数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求ID。 encoded_authorization_message String 鉴权信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最大长度：2048 表3 请求Body参数 参数 是否必选 参数类型 描述 operations 是 Array of objects 更新的用户属性列表。 数组长度：1-100 表4 operations 参数 是否必选 参数类型 描述 attribute_path 是 String 要更新的属性的字符串表示。 最小长度：1 最大长度：255 attribute_value 否 String 要更新的属性值。当属性为对象类型时，此处填写对象的JSON字符串。为null时表示删除对应属性。

URI PUT /v1/identity-stores/{identity_store_id}/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 identity_store_id 是 String 身份源的全局唯一标识符（ID）。 最小长度：12 最大长度：12 user_id 是 String 身份源中IAM身份中心用户的全局唯一标识符（ID）。 最小长度：1 最大长度：64

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最大长度：2048 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 权限集的描述。 最小长度：0 最大长度：1024 relay_state 否 String 用于在联合身份验证过程中重定向应用程序中的用户。 最小长度：0 最大长度：240 session_duration 否 String 应用程序用户会话在ISO-8601标准中有效的时间长度。 最小长度：1 最大长度：100

请求示例 更新指定实例的访问控制属性配置。 PUT https://{hostname}/v1/instances/{instance_id}/access-control-attribute-configuration { "instance_access_control_attribute_configuration" : { "access_control_attributes" : [ { "key" : "email", "value" : { "source" : [ "${path:emails[primary eq true].value}" ] } }, { "key" : "nickName", "value" : { "source" : [ "${path:nickName}" ] } } ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最大长度：2048 表3 请求Body参数 参数 是否必选 参数类型 描述 instance_access_control_attribute_configuration 是 Object 更新ABAC配置的属性。 表4 instance_access_control_attribute_configuration 参数 是否必选 参数类型 描述 access_control_attributes 是 Array of objects IAM身份中心实例中ABAC配置的属性。 数组长度：0 - 20 表5 access_control_attributes 参数 是否必选 参数类型 描述 key 是 String 与您的身份源中的身份关联的属性的名称。 最小长度：1 最大长度：128 value 是 Object 用于将指定属性映射到身份源的值。 表6 value 参数 是否必选 参数类型 描述 source 是 Array of strings 用于将指定属性映射到身份源的值。 最小长度：0 最大长度：255 数组长度：1-1

响应参数 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 request_id String 请求唯一标识。

URI PUT /v1/identity-stores/{identity_store_id}/groups/{group_id} 表1 路径参数 参数 是否必选 参数类型 描述 identity_store_id 是 String 身份源的全局唯一标识符（ID）。 最小长度：12 最大长度：12 group_id 是 String 身份源中IAM身份中心用户组的全局唯一标识符（ID）。 最小长度：1 最大长度：64

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最大长度：2048 表3 请求Body参数 参数 是否必选 参数类型 描述 operations 是 Array of objects 更新的用户组属性列表。 数组长度：1-100 表4 operations 参数 是否必选 参数类型 描述 attribute_path 是 String 要更新的属性的字符串表示。 最小长度：1 最大长度：255 attribute_value 否 String 要更新的属性值。当属性为对象类型时，此处填写对象的JSON字符串。为null时表示删除对应属性。

请求示例 根据用户组ID，更新对应IAM身份中心用户组的属性。 PUT https://{hostname}/v1/identity-stores/{identity_store_id}/groups/{group_id} { "operations" : [ { "attribute_path" : "description", "attribute_value" : "更新用户组描述" } ] }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 device_code String 设备在轮询会话令牌时使用的设备码。 expires_in Integer 设备码失效时间（以秒为单位）。 interval Integer 指示轮询会话时，客户端在两次尝试之间必须等待的秒数。 user_code String 一次性用户验证码。授权正在使用的设备时需要此操作。 verification_uri String 使用一次性用户验证码授权设备的验证页面的URI。 verification_uri_complete String 客户端可用于自动启动浏览器的备用URL。此过程跳过用户访问验证页面并输入代码的手动步骤。

响应示例 状态码： 200 Successful { "device_code" : "1234567890123456789012345678901234567890123456789012345678901234", "expires_in" : 1684955360, "interval" : 10, "user_code" : "1234567890123456", "verification_uri" : "https://example-erification.example.com/erification/url", "verification_uri_complete" : "https://example-erification-complete.example.com/erification/url" }

请求示例 请求设备授权。 POST https://{hostname}/v1/device/authorize { "client_id" : "example_client_id", "client_secret" : "example_client_secret", "start_url" : "https://example-start.example.com/start/url" }

响应示例 状态码： 200 Successful { "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig" ], "documentationUri" : null, "authenticationSchemes" : [ { "type" : "authenticationtype", "name" : "Authentication Name", "description" : "Authentication scheme using the AAA Authentication Standard", "specUri" : "http://www.example.org/doc/auth1234", "documentationUri" : null, "primary" : true } ], "patch" : { "supported" : false }, "bulk" : { "supported" : false, "maxOperations" : null, "maxPayloadSize" : null }, "filter" : { "supported" : false, "maxResults" : null }, "changePassword" : { "supported" : false }, "sort" : { "supported" : false }, "etag" : { "supported" : false } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 schemas Array of strings 概要。 documentationUri String 帮助文档链接。 authenticationSchemes Array of objects 认证概要列表。 patch Object 表示服务提供商是否支持部分修改操作，及对部分修改操作的相关配置。 bulk Object 表示服务提供商是否支持批量操作，及对批量操作的相关配置。 filter Object 表示服务提供商是否支持过滤操作，及对过滤操作的相关配置。 changePassword Object 表示服务提供商是否支持修改密码操作，及对修改密码操作的相关配置。 sort Object 表示服务提供商是否支持排序操作，及对排序操作的相关配置。 etag Object 表示服务提供商是否支持电子标签，及对电子标签的相关配置。 表4 authenticationSchemes 参数 参数类型 描述 type String 认证类型，指定鉴权的方式。 name String 认证概要名称。 description String 认证概要的描述信息。 specUri String 规范链接。 documentationUri String 帮助文档链接。 primary Boolean 是否为主要的认证方式。 表5 patch 参数 参数类型 描述 supported Boolean 一个布尔值，表示服务提供商是否支持这种操作。 表6 bulk 参数 参数类型 描述 supported Boolean 一个布尔值，表示服务提供商是否支持这种操作。 maxOperations Integer 一次可操作的最大个数。 maxPayloadSize Integer 最大有效载荷量。 表7 filter 参数 参数类型 描述 supported Boolean 一个布尔值，表示服务提供商是否支持这种操作。 maxResults Integer 最大结果数。 表8 changePassword 参数 参数类型 描述 supported Boolean 一个布尔值，表示服务提供商是否支持这种操作。 表9 sort 参数 参数类型 描述 supported Boolean 一个布尔值，表示服务提供商是否支持这种操作。 表10 etag 参数 参数类型 描述 supported Boolean 一个布尔值，表示服务提供商是否支持这种操作。 状态码： 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 时间戳。

请求示例 更新用户。 PUT https://{hostname}/{tenant_id}/scim/v2/Users/{user_id} { "id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9", "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 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 时间戳。