调用PatchUser接口,更新一个EIAM账户信息。
接口说明
接口符合 HTTP Patch 方法语义,只修改传入的参数值,不传则默认不修改。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
PATCH /v2/{instanceId}/{applicationId}/users/{userId}
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Authorization | string | 是 | 认证信息。 格式:Bearer ${access_token}。 示例:Bearer ATxxxx。 | Bearer AT8csE2seYxxxxxij |
instanceId | string | 是 | 实例 ID。 | idaas_ue2jvisn35ea5lmthk267xxxxx |
applicationId | string | 是 | 应用 ID。 | app_mkv7rgt4d7i4u7zqtzev2mxxxx |
userId | string | 是 | 账户 ID。 | user_d6sbsuumeta4h66ec3il7yxxxx |
body | object | 否 | 请求 body。 | |
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 | 否 | 扩展字段更新操作对象。 | ||
operatordeprecated | string | 否 | 字段操作类型,已废弃,请采用 operation 替换使用。 | replace |
fieldName | string | 否 | 扩展字段标识,类型和值域可通过控制台查看对应扩展字段值的详细信息。 | age |
fieldValue | string | 否 | 扩展字段值。 | test_value |
operation | string | 否 | 字段操作类型,取值可选范围:
| replace |
返回参数
示例
正常返回示例
JSON
格式
{}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-10-24 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-04-16 | API 内部配置变更,不影响调用 | 查看变更详情 |
错误码
HttpCode | Error Code | 错误信息 | 说明 |
---|---|---|---|
400 | invalid_token | Access token is not valid | token 无效 |
400 | MissingParameter.xxxx | The specified parameter:xxx is required! | 缺少 xxxx 参数 |
400 | InvalidParameter.xxxx | The specified parameter:xxxx is required! | xxxx 参数无效 |
404 | ResourceNotFound.User | The specified User resource: user_d6sbsuumeta4h66ec3il7yxxxx not found. | 账户不存在 |
404 | application_not_found | Application id not found: app_mkv7rgt4d7i4u7zqtzev2mxxxx | 应用不存在 |
403 | application_disabled | Application is disabled | 应用处于禁用状态 |
403 | application_api_disabled | Application api invoke disabled | 应用 API 未开放 |
403 | permission_denied | Require scopes: [urn:alibaba:idaas:scope:user:manager_all] | 缺少 API 授权信息 |
500 | Internal Server Error | Internal Server Error | 服务器内部错误 |