文档首页/ 云客服/ API参考/ 其他类接口参考/ 创建用户
更新时间：2025-03-07 GMT+08:00
查看PDF
分享

创建用户

场景描述

增加AppCube租户下业务用户。

接口方法

Post

接口URI

https://域名/apiacces /rest/sum/v1/tenantSpaces/users，例如域名是service.besclouds.com。

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

False

appKey字段，用户标识，请联系运营人员获取appKey。

2

Authorization

string

True

鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）。

生成方式参见文档C1 系统配置类接口鉴权方式式章节。

3

Content-Type

string

False

"application/json"
表2 请求体参数

序号

参数

是否必选

类型

描述

1

userAccount

是

String

租户下用户账号，用于后续的登录标识。

唯一性，最多64个字符 只允许输入数字，大小写字母以及符号_-@.

2

userName

是

String

用户的展示名称，最多64个字节，不能包含以下字符:~#$%&*()/=+{}<>\[\];'"|!,

3

phone

否

String

租户下用户联系号码，长度不超过32字符。

4

email

否

String

租户下用户邮箱地址(符合RFC 2882)。

邮箱长度不超过64字符。

5

profile

否

String

仅适用于CASE独立部署环境。

业务用户权限，只可传参"Operator"或"Administrator"，如未传递profile参数，则默认为"Operator"。其中"Administrator"为管理员权限，"Operator"为基础操作权限。

6

description

否

String

仅适用于OP集成部署环境。

用户的描述信息，长度不超过540。

7

password

是

String

仅适用于OP集成部署环境。

用户登录的密码，密码采用HTTPS传输。

长度8-20（默认密码规则组），默认需要提供四种：大写字母、小写字母、数字和特殊字符。

特殊字符是指~`!@#$%^*()-+_=\¦,./<>?;':"[]{}\&

8

status

否

Integer

仅适用于OP集成部署环境。

用户状态：

0:待激活,

1:激活,

2:暂停。

9

orgId

否

String

仅适用于OP集成部署环境。

组织标识，可选，创建的用户自动加入顶层组织

10

title

否

String

仅适用OP集成部署环境。

用户职位，

"1":"服务代理",

"2":"VIP服务代理",

"3":"组长",

"4":"在线管理员",

"5":"管理员",

"6":"主管",

"7":"配置管理员"。

11

gender

否

Integer

仅适用OP集成部署环境。

性别：

0：女性；

1：男性；

9：资料不详。

不指定则默认值 为9。

12

salt

否

String

仅适用于OP集成部署环境。

盐值，传递加密时使用的盐值。

与SUM侧约定加密的算法，SUM侧提供接口更改迭代次数和KeyLength

响应说明

  • 响应状态码: 200
    表3 响应体参数

    序号

    名称

    参数类型

    说明

    1

    message

    string

    用户描述。

    2

    retcode

    string

    错误码。取值如下：

    0：成功

    非0：失败

    3

    result

    Object

    查询成功后，返回结果信息的对象。
    表4 Result对象

    序号

    参数

    类型

    描述

    1

    userId

    String

    系统产生的租户账户唯一标识

错误码

  • 响应状态码: 400

    错误的请求：请检查请求路径及参数。

  • 响应状态码: 401

    未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。

  • 响应状态码: 403

    鉴权失败。

  • 响应状态码: 404

    请求的内容未找到：请检查请求的路径。

  • 响应状态码: 500

    业务失败：请依次确认您请求中各参数的取值。

报文样例

场景描述：创建用户

URL：https://域名/apiaccess/rest/sum/v1/tenantSpaces/users

  • 请求头
x-app-key:953587d812f642998ee1f633b81212f3
Authorization:Bearer e3fca9398eaa5cef4b57b523b9c75fae
Content-Type:application/json

  • 请求消息:
{
"userAccount":"userAccount01",
"userName":"userName01",
"phone":"13012341234",
"email":"test@huawei.com",
"profile":"Operator"
}

  • 响应消息:
{
"message": "",
"retcode": "0",
"result": {
"userId"："2461227935"
}
}
父主题： 其他类接口参考