用户批量同步

 

一、接口URL

/user/batch/on/official?token=xxxxxxxxxxxxx

 

二、功能

用户同步(*注: 07:00-23:59时段同步阀值10000次/天,超出返回错误;00:00-06:59时段不做阀值限制)

 

三、请求参数

名称 类型 是否必传 传参方式 说明
token String true RequestParam 访问的key
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 办公地点, 选填。
externalOrigName String false RequestBody 域账号,需要ad登录,必填。
externalConfigId String false RequestBody 域配置id,全时提供,可以写死, 需要ad登录,必填。
externalConfigAddr String false RequestBody 域dn,需要ad登录,必填。
parentNames Array true RequestBody 父部门名称,字符串数组, "Operate"字段为"new","update","move"时有效; 如: 研发部/服务器组,格式为:[ "研发部", "服务器组" ]
oldParentNames Array false RequestBody 旧部门名称, "Operate"字段为"move"时有效; 必填; 部门名称字符串数组, 如:"研发部/服务器组", [ "研发部","服务器组"]。
tags Array false RequestBody 标签信息,包含字段tagId、tagValue,如:[{"tagId":1453,"tagValue":"value4"},{"tagId":1451,"tagValue":"value4"}]

 

四、请求体

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": [
            "研发部",
            "测试组"
        ],
        "tags": [
            {
                "tagId": 1453,
                "tagValue": "value4"
            },
            {
                "tagId": 1451,
                "tagValue": "value4"
            }
        ]
    }
]

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": "广州",
        "tags": [
            {
                "tagId": 1453,
                "tagValue": "value4"
            },
            {
                "tagId": 1451,
                "tagValue": "value4"
            }
        ]
    }
]

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

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

 

五、返回参数

|名称 |类型 |说明| |errorCode |Integer |结果码,0: 成功, 非0:失败 (具体描述见错误码表)| |errorMessage |String |错误描述| |requestId |String |请求唯一ID。|

 

六、返回体

{
    "errorCode": -1,
    "errorMessage": "未知错误",
    //所有数据都成功返回success"requestId": "openapi-ums-165-17e9061a-adc5-4392-b160-0305fb65a0f5",
    "data": [
        //返回没有成功的数据的错误,
        成功的不返回{
            "errorCode": 40005,
            "errorMessage": "账号id不合法",
            "requestId": "openapi-ums-165-17e9061a-adc5-4392-b160-0305fb65a0f5",
            "data": "test_batch@quanshi.com"//返回未成功的loginName
        }
    ]
}

或:

{
    "errorCode": 0,
    "errorMessage": "success",
    "requestId": "openapi-ums-165-17e9061a-adc5-4392-b160-0305fb65a0f5",
    "data": []
}

 

七、备注

1. 删除部门时, 此部门必须没有用户,也没有子部门。 2. 部门改名、移动时,新部门的父部门必须存在。