批量新增/修改用户

请求参数

Query 参数

project

string

可选

项目id或者项目编码。可由实施提供或者通过项目列表接口获取(http://aiot.docs.chn-das.com/api-139664251)

默认值:

1192410229407772672

instance

string

实例

可选

Header 参数

Authorization

string

jwt凭证

必需

示例值:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJVamdBcm4wcyIsInNlcnZlciI6dHJ1ZSwidXNlcl9uYW1lIjoi5rWL6K-V562W55WlIiwic2NvcGUiOlsic2VydmVyIl0sIm5hbWUiOiLmtYvor5XnrZbnlaUiLCJwcm9qZWN0IjoiNDA5ODE4NDY2MTYwNzA5IiwiZXhwIjoxNjg0ODcxMjYwLCJ0ZW5hbnQiOiJ0NDA5ODE4NDY2MTYwNzA5IiwiY2xpZW50X2lkIjoic3lzIn0._E-RDguiasgicVmdYdOs4dsI_oKVsOremFWLENLzGyI

Body 参数application/json

data

array [object {12}]

数据

必需

string

来源方用户ID

必需

租户下唯一，识别用户唯一性

name

string

用户姓名

可选

新增时不可为空，修改时如果为空则不更新该字段，否则覆盖

phone

string

手机号

可选

可空，全局唯一，修改时如果为空则不更新该字段，否则覆盖，注：如果手机号被其他用户使用则报错（异常数据）。如需使用手机号登录AIoT平台需传值。

gender

integer

性别

可选

1：男 2：女。默认值1，修改时如果为空则不更新该字段，否则覆盖

string

邮箱

可选

可空，全局唯一，修改时如果为null则不更新该字段，否则覆盖，注：如果邮箱被其他用户使用则报错（异常数据）

status

integer

状态

可选

1：正常 2：锁定 3：注销（离职）。默认值1，修改时如果为空则不更新该字段，否则覆盖

headPicture

string

头像链接URL

可选

修改时如果为null则不更新该字段，否则覆盖

facePicture

string

人脸照片URL

可选

修改时如果为null则不更新该字段，否则覆盖

areaCode

string

手机区号

可选

默认值+86，修改时如果为空则不更新该字段，否则覆盖

orgIds

array[string]

来源方组织ID列表

可选

来源方用户关联的组织ID，新增时不可为null或者空数组，更新时如果为null或空数组则不处理，否则覆盖原有的组织

roleIds

array[string]

来源方角色ID列表

可选

来源方用户关联的角色ID，null值忽略用户角色关系，非null值更新时覆盖原有的角色，注：传空数组更新会移除该用户绑定的所有角色

params

object

用户参数（扩展字段）

可选

字典结构，用于存储接口调用方的业务字段，包含车牌号、用户住址等业务字段，修改时如果key为空则不更新该字段，否则覆盖（key为用户参数编码，需要提前创建)。常用字段约定：入职日期：entryDate，格式yyyy-MM-dd；生日：birthday，格式yyyy-MM-dd。备注：用户参数使用前请先联系管理员配置。

dataSyncRule

integer

同步规则

可选

1：用户ID存在时更新 2：用户ID存在时跳过不更新。默认值1

示例

{
  "data": [
    {
      "id": "1",
      "name": "张三",
      "phone": "13333333333",
      "orgIds": [
        "1"
      ],
      "roleIds": [],
      "params": {
        "employeeNo": "10010",
        "entryDate": "2025-01-01",
        "birthday": "2000-01-01"
      },
      "status": 1,
      "email": "",
      "areaCode": "+86",
      "gender": 1,
      "headPicture": ""
    },
    {
      "id": "2",
      "name": "李四",
      "phone": "13333333332",
      "orgIds": [
        "1"
      ],
      "roleIds": [],
      "params": {
        "employeeNo": "10011",
        "entryDate": "2025-01-01",
        "birthday": "2000-01-01"
      },
      "status": 1,
      "email": "",
      "areaCode": "+86",
      "gender": 1,
      "headPicture": ""
    }
  ],
  "dataSyncRule": 1
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

data

array [object {3}]

异常数据

必需

string

来源方用户ID

必需

status

string

错误编码

必需

msg

string

错误描述

必需

示例

{
  "data": [
    {
      "id": "1",
      "status": "PHONE_EXISTS",
      "msg": "手机号已存在"
    }
  ]
}

🟠400400响应结构