修改用户
场景描述
调用此接口来更新用户信息，采用Patch方法，支持消息体中指定的字段的局部更新，即若指定了phone字段，则更新phone字段，若指定了email字段，则更新email字段。
接口方法
PATCH
接口URI
https://域名/apiaccess/rest/sum/v1/tenantSpaces/users/{userId}，例如域名是service.besclouds.com
URL参数
|
序号 |
参数 |
是否为必选 |
类型 |
描述 |
|---|---|---|---|---|
|
1 |
userId |
是 |
String |
租户下用户唯一标识。 |
请求说明
|
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
|
1 |
X-APP-Key |
string |
False |
app标识。 |
|
2 |
Authorization |
string |
True |
鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）。 |
|
序号 |
参数 |
是否必选 |
类型 |
描述 |
|
1 |
userName |
否 |
String |
用户的展示名称，最多64个字节，不能包含以下字符:~#$%&*()/=+{}<>\[\];'"|!, |
|
2 |
phone |
否 |
String |
租户下用户联系号码，长度不超过32字符。 |
|
3 |
|
否 |
String |
租户下用户邮箱地址(符合RFC 2882)。 邮箱长度不超过64字符。 |
|
4 |
profile |
否 |
String |
仅适用于CASE独立部署环境。 业务用户权限，只可传参"Operator"或"Administrator"，如未传递profile参数，则不做修改。 其中"Administrator"为管理员权限，"Operator"为基础操作权限。 |
|
5 |
description |
否 |
String |
仅适用于OP集成部署环境。 用户的描述信息，长度不超过540。 |
|
6 |
status |
否 |
Integer |
仅适用于OP集成部署环境。 用户状态： 0:待激活, 1:激活, 2:暂停。 |
|
7 |
title |
否 |
String |
仅适用于OP集成部署环境。 用户职位， "1":"服务代理", "2":"VIP服务代理", "3":"组长", "4":"在线管理员", "5":"管理员", "6":"主管", "7":"配置管理员" |
|
8 |
gender |
否 |
Integer |
仅适用于OP集成部署环境。 性别： 0：女性； 1：男性； 9：资料不详。 不指定则默认值 为9。 |
响应说明
- 响应状态码: 200
表4 响应体参数 序号
名称
参数类型
说明
1
message
string
描述。
2
retcode
string
错误码。取值如下：
0：成功
非0：失败
错误码
- 响应状态码: 400
错误的请求：请检查请求路径及参数。
- 响应状态码: 401
未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。
- 响应状态码: 403
鉴权失败。
- 响应状态码: 404
请求的内容未找到：请检查请求的路径。
- 响应状态码: 500
业务失败：请依次确认您请求中各参数的取值。
报文样例
场景描述：修改用户
URL：https://域名/apiaccess/rest/sum/v1/tenantSpaces/users/{userId}
- 请求头
x-app-key:953587d812f642998ee1f633b81212f3 Authorization:Bearer e3fca9398eaa5cef4b57b523b9c75fae Content-Type:application/json
- 请求消息:
{
"userName":"userName01",
"phone":"12012341234",
"email":"test@huawei.com",
"profile":"Operator"
}
- 响应消息:
{
"message": "",
"retcode": "0"
}
