调用PatchUser接口,更新一个EIAM账户信息。
接口说明
接口符合 HTTP Patch 方法语义,只修改传入的参数值,不传则默认不修改。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
PATCH /v2/{instanceId}/{applicationId}/users/{userId} HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| instanceId |
string |
是 |
实例 ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| applicationId |
string |
是 |
应用 ID。 |
app_mkv7rgt4d7i4u7zqtzev2mxxxx |
| userId |
string |
是 |
账户 ID。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Authorization |
string |
是 |
认证信息。 格式:Bearer ${access_token}。 示例:Bearer ATxxxx。 |
Bearer AT8csE2seYxxxxxij |
| body |
object |
否 |
请求 body。 |
user_001 |
| username |
string |
否 |
账户名。 |
name001 |
| displayName |
string |
否 |
账户展示名。 |
display_name001 |
| phoneRegion |
string |
否 |
手机地区编号,示例:中国大陆手区号为 86,不带 00 或 +, 手机号若设置,此参数必填。 |
86 |
| phoneNumber |
string |
否 |
账户手机号。 |
156xxxxxxx |
| phoneNumberVerified |
boolean |
否 |
手机号是否验证,手机号若设置此字段必须设置,无特殊业务可直接设置为 true。 |
true |
|
string |
否 |
账户邮箱。 |
example@example.com |
|
| emailVerified |
boolean |
否 |
邮箱是否验证,邮箱若设置此字段必须设置,无特殊业务可直接设置为 true。 |
true |
| customFields |
array<object> |
否 |
账户扩展字段列表。 |
|
|
object |
否 |
扩展字段更新操作对象。 |
||
operator
deprecated
|
string |
否 |
字段操作类型,已废弃,请采用 operation 替换使用。 |
replace |
| fieldName |
string |
否 |
扩展字段标识,类型和值域可通过控制台查看对应扩展字段值的详细信息。 |
age |
| fieldValue |
string |
否 |
扩展字段值。 |
test_value |
| operation |
string |
否 |
字段操作类型,取值可选范围:
|
replace |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
当前API暂无返回参数
示例
正常返回示例
JSON格式
{}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。