調用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 | 服務器內部錯誤 |