批量创建用户

POST/public-api/users/add

:::note[接口简介]
若您想要在添加用户时绑定用户的企业微信、钉钉或者云之家账号，请在"userDefinedProperties"内添加对应的账号信息。对应的账号信息可以在“管理中心”-“用户基础属性管理”-“基础属性”中查看对应的属性名称。
:::

请求参数

token

string

应用Token

必需

在观远平台管理员设置-系统集成-统一账户集成中获得

userPropertyType

enum<number>

用户属性类型

可选

0:使用key；1:使用名称。默认为0。

枚举值:

默认值:

users

array [object {8}]

需要创建的用户列表

必需

用户列表，包含用户各个属性字段，具体详见示例。

name

string

用户名

必需

用户登录后显示名称

loginId

string

账号

必需

用以在用户界面登录的信息以及通过api管理用户属性的id，如邮箱、工号、手机号等。如果使用邮箱登录，则此处填写邮箱，和下述email字段并不冲突。

password

string

密码

可选

账号登录密码，必须BASE64加密。SSO等非账密登录场景下可不提供该字段信息，不传或者传空时，会使用随机密码。

role

enum<string>

用户角色

可选

目前可支持admin，editor，participant三类

枚举值:

admineditorparticipant

默认值:

participant

string

邮箱

可选

mobile

string

手机号

可选

enabled

boolean

用户状态

可选

布尔值，只能填true和false。true对应“启用”，false对应“禁用”。

userDefinedProperties

object

可选

观远平台内已经添加的用户属性名称

{
  "token": "string",
  "userPropertyType": 1,
  "users": [
    {
      "name": "string",
      "loginId": "string",
      "password": "string",
      "role": "participant",
      "email": "string",
      "mobile": "string",
      "enabled": true,
      "userDefinedProperties": {
        "企业微信账号": "string",
        "钉钉账号": "string"
      }
    }
  ]
}

示例代码

返回响应

成功(200)

服务器错误(500)

HTTP 状态码: 200

内容格式: JSONapplication/json

result

string

请求状态

必需

枚举值: ok、fail

response

string

响应结果

必需

{
  "result": "ok",
  "response": "2 Users created successfully"
}

最后修改时间： 1 个月前