更新时间:2025-09-18 GMT+08:00
分享

批量导入用户

功能介绍

批量导入用户

调用方法

请参见如何调用API

URI

POST /v1/csms/users/batch-import

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表2 请求Body参数

参数

是否必选

参数类型

描述

total

Integer

导入条数

users

Array of CreateUserRequest objects

用户列表

表3 CreateUserRequest

参数

是否必选

参数类型

描述

user_name

String

用户名,用户唯一标识,企业内唯一。

mobile

String

手机号,企业内唯一。

password

String

密码,需要满足企业定义的格式。

org_code

String

主组织的组织编码,填写企业中存在的组织编码。为空时组织在第一个根组织下。

name

String

姓名,为空值时设置为user_name。可在管理门户界面,用户菜单下的用户属性定义中修改必填属性。

email

String

邮箱。可在管理门户界面,用户菜单下的用户属性定义中修改必填属性。

employee_id

String

员工id。可在管理门户界面,用户菜单下的用户属性定义中修改必填属性。

first_name

String

名字。可在管理门户界面,用户菜单下的用户属性定义中修改必填属性。

middle_name

String

中间名。可在管理门户界面,用户菜单下的用户属性定义中修改必填属性。

last_name

String

姓氏。可在管理门户界面,用户菜单下的用户属性定义中修改必填属性。

pwd_must_modify

Boolean

首次登录是否需要强制修改密码。缺省值:true

attr_gender

String

性别。

attr_birthday

String

生日,格式为yyyy-mm-dd。

attr_nick_name

String

昵称。

attr_identity_type

String

证件类型。

attr_identity_number

String

证件号码。

attr_area

String

国家或者地区的编码。

attr_city

String

城市。

attr_manager_id

String

直属上级。

attr_user_type

String

人员类型。枚举值:regular:正式 intern:实习

dispatch:劳务派遣 outsourcing:劳务外包

attr_hire_date

String

入职时间,格式为yyyy-MM-dd。

attr_work_place

String

工作地点。

user_org_relation_list

Array of UserOrgRelationListOption objects

用户组织关系集合。若填写,必须包含主组织的信息。

extension

Object

自定义扩展属性。

表4 UserOrgRelationListOption

参数

是否必选

参数类型

描述

orgCode

String

组织编码

relationType

String

归属关系,同一用户只能有1个归属,最多9个挂靠。

枚举值:0:挂靠 1:归属

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

error_list

Array of ErrorInfo objects

失败描述

total

Integer

总条数

success

Integer

成功条数

failed

Integer

失败条数

表6 ErrorInfo

参数

参数类型

描述

name

String

名称

error_msg

String

失败原因

请求示例

响应示例

状态码

状态码

描述

200

导入情况

错误码

请参见错误码

相关文档