文档

PatchUser - 更新一个EIAM账户信息

更新时间:

调用PatchUser接口,更新一个EIAM账户信息。

接口说明

接口符合 HTTP Patch 方法语义,只修改传入的参数值,不传则默认不修改。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

PATCH /v2/{instanceId}/{applicationId}/users/{userId}

请求参数

名称类型必填描述示例值
Authorizationstring

认证信息。 格式:Bearer ${access_token}。 示例:Bearer ATxxxx。

Bearer AT8csE2seYxxxxxij
instanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
applicationIdstring

应用 ID。

app_mkv7rgt4d7i4u7zqtzev2mxxxx
userIdstring

账户 ID。

user_d6sbsuumeta4h66ec3il7yxxxx
bodyobject

请求 body。

usernamestring

账户名。

name001
displayNamestring

账户展示名。

display_name001
phoneRegionstring

手机地区编号,示例:中国大陆手区号为 86,不带 00 或 +, 手机号若设置,此参数必填。

86
phoneNumberstring

账户手机号。

156xxxxxxx
phoneNumberVerifiedboolean

手机号是否验证,手机号若设置此字段必须设置,无特殊业务可直接设置为 true。

true
emailstring

账户邮箱。

example@example.com
emailVerifiedboolean

邮箱是否验证,邮箱若设置此字段必须设置,无特殊业务可直接设置为 true。

true
customFieldsarray<object>

账户扩展字段列表。

object

扩展字段更新操作对象。

operatordeprecatedstring

字段操作类型,已废弃,请采用 operation 替换使用。

replace
fieldNamestring

扩展字段标识,类型和值域可通过控制台查看对应扩展字段值的详细信息。

age
fieldValuestring

扩展字段值。

test_value
operationstring

字段操作类型,取值可选范围:

  • add:添加。
  • replace:替换。若对应扩展字段无设置值,会转换为 add 操作。
  • remove:移除。
replace

返回参数

名称类型描述示例值
当前API暂无返回参数

示例

正常返回示例

JSON格式

{}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-24API 内部配置变更,不影响调用查看变更详情
2023-04-16API 内部配置变更,不影响调用查看变更详情

错误码

HttpCodeError Code错误信息说明
400invalid_tokenAccess token is not validtoken 无效
400MissingParameter.xxxxThe specified parameter:xxx is required!缺少 xxxx 参数
400InvalidParameter.xxxxThe specified parameter:xxxx is required!xxxx 参数无效
404ResourceNotFound.UserThe specified User resource: user_d6sbsuumeta4h66ec3il7yxxxx not found.账户不存在
404application_not_foundApplication id not found: app_mkv7rgt4d7i4u7zqtzev2mxxxx应用不存在
403application_disabledApplication is disabled应用处于禁用状态
403application_api_disabledApplication api invoke disabled应用 API 未开放
403permission_deniedRequire scopes: [urn:alibaba:idaas:scope:user:manager_all]缺少 API 授权信息
500Internal Server ErrorInternal Server Error服务器内部错误