用户批量同步-异步

 

一、接口URL

/user/batch/async/on/official?token=XXXXXXXXXXX&batchNo=XXXXXXXXXX

 

二、功能

用户批量同步异步接口,只返回同步状态,最终同步结果需要通过/user/batch/async/on/result接口查询。每次同步用户最多1万 (*注: 07:00-23:59时段同步阀值10000次/天,超出返回错误;00:00-06:59时段不做阀值限制)

 

三、请求参数

名称 类型 是否必传 传参方式 说明
token String true RequestParam 访问的key
batchNo String true RequestParam 访问批次号--每次批量操作请求需要唯一
Operate String true RequestBody 同步动作,候选值:"new": 新增用户 "update": 修改用户 "delete": 删除用户 "move": 移动用户到指定部门
loginName String true RequestBody 用户名(登录名), 必填; 必须是邮件地址格式。
email String true RequestBody 用户邮箱, 必填; 必须是邮件地址格式。。
mobile String false RequestBody 手机号, 选填。
lastName String false RequestBody 姓,lastName/firstName必填一个。
firstName String false RequestBody 名, lastName/firstName必填一个。
displayName String false RequestBody 显示名称, 选填。
title String false RequestBody 职务,选填。
office String false RequestBody 办公地点, 选填。
parentNames Array true RequestBody 父部门名称,字符串数组, "Operate"字段为"new","update","move"时有效; 如: 研发部/服务器组,格式为:[ "研发部", "服务器组" ]
oldParentNames Array false RequestBody 旧部门名称, "Operate"字段为"move"时有效; 必填; 部门名称字符串数组, 如:"研发部/服务器组", [ "研发部","服务器组"]。

 

四、请求体

1.新建用户, 在“研发部/服务器组”新增用户“test@quanshi.com”:

[
    {
        "Operate": "new",
        "loginName": "test@quanshi.com",
        "email": "test@quanshi.com",
        "mobile": "13912345678",
        "lastName": "王",
        "firstName": "小明",
        "displayName": "王小明",
        "title": "软件工程师",
        "office": "苏州",
        "parentNames": [
            "研发部",
            "服务器组"
        ]
    },
    {
        "Operate": "new",
        "loginName": "test_batch@quanshi.com",
        "email": " test_batch @quanshi.com",
        "mobile": "13912345678",
        "lastName": "陆",
        "firstName": "小婷",
        "displayName": "陆小婷",
        "title": "测试工程师",
        "office": "广州",
        "parentNames": [
            "研发部",
            "测试组"
        ]
    }
]

2.删除用户:


[
    {
        "Operate": "delete",
        "loginName": "test@quanshi.com"
    },
    {
        "Operate": "delete",
        "loginName": "test_batch@quanshi.com"
    }
]

3.修改用户

[
    {
        "Operate": "update",
        "loginName": "test@quanshi.com",
        "email": "test@quanshi.com",
        "mobile": "13912345678",
        "lastName": "王",
        "firstName": "小明",
        "displayName": "王小明",
        "title": "软件工程师",
        "office": "苏州"
    },
    {
        "Operate": "update",
        "loginName": "test_batch@quanshi.com",
        "email": "test_ batch @quanshi.com",
        "mobile": "13912345678",
        "lastName": "陆",
        "firstName": "小婷",
        "displayName": "陆小婷",
        "title": "测试工程师",
        "office": "广州"
    }
]

4.用户移动,从"研发部/服务器组" 移动到 "研发部/后台任务组":

[
    {
        "Operate": "move",
        "loginName": "test@quanshi.com",
        "oldParentNames": [
            "研发部",
            "服务器组"
        ],
        "parentNames": [
            "研发部",
            "后台工作组"
        ]
    },
    {
        "Operate": "move",
        "loginName": "test_batch@quanshi.com",
        "oldParentNames": [
            "研发部",
            "测试组"
        ],
        "parentNames": [
            "研发部",
            "测试组"
        ]
    }
]

 

五、返回参数

名称 类型 说明 errorCode Integer 结果码,0: 成功, 非0:失败 (具体描述见错误码表) data.status Integer 执行状态, 0:进行中,1:已结束-全部成功,2:已结束-部分成功 根据token+batchNo判断第一次请求返回0,如果用相同的token+batchNo第二次请求会返回当前的执行状态0、1或者2 errorMessage String 错误描述 requestId String 请求唯一ID。

 

六、返回体

{
    "errorCode": -1,
    "data": {

    },
    "errorMessage": "未知错误",
    "requestId": "openapi-ums-165-17e9061a-adc5-4392-b160-0305fb65a0f5",

}

或:

{
    "errorCode": 0,
    "data": {
        "status": 0
    },
    "errorMessage": "Successful!",
    "requestId": "redis1-cb33dcfd-efa6-4c20-b380-843294c78f9a"
}