创建用户

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	否	—	—
第三方个人应用	否	—	—

请求参数

Query 参数

access_token

必需

调用服务端API授权凭证，可通过获取企业内部应用的access_token接口获取。

示例值:

Body 参数application/json

userid

string

可选

员工唯一标识ID（不可修改），企业内必须唯一。长度为1~64个字符，如果不传，将自动生成一个userid。

name

string

必需

员工名称，长度最大80个字符。

mobile

string

必需

手机号码，企业内必须唯一，不可重复。如果是国际号码，请使用+xx-xxxxxx的格式。

hide_mobile

boolean

可选

是否号码隐藏：true：隐藏隐藏手机号后，手机号在个人资料页隐藏，但仍可对其发DING、发起钉钉免费商务电话。false：不隐藏

telephone

string

可选

分机号，长度最大50个字符。企业内必须唯一，不可重复。

job_number

string

可选

员工工号，长度最大为50个字符。

manager_userid

string

可选

直属主管的userId。

title

string

可选

职位，长度最大为200个字符。

email

string

可选

员工邮箱，长度最大50个字符。企业内必须唯一，不可重复。

org_email

string

可选

员工的企业邮箱，长度最大100个字符。员工的企业邮箱已开通，才能增加此字段。

org_email_type

string

可选

员工的企业邮箱类型，仅对支持的组织生效（profession: 标准版，base: 基础版）。

work_place

string

可选

办公地点，长度最大100个字符。

remark

string

可选

备注，长度最大2000个字符。

dept_id_list

string

必需

所属部门id列表，可通过获取部门列表接口获取。

dept_order_list

array [object {2}]

可选

员工在对应的部门中的排序。

dept_id

number

部门ID。

可选

order

number

可选

员工在部门中的排序。

dept_title_list

array [object {2}]

可选

员工在对应的部门中的职位。

dept_id

number

部门ID。

可选

title

string

可选

员工在部门中的职位。

extension

object

可选

扩展属性，可以设置多种属性，最大长度2000个字符。在使用该参数前，需要先在OA管理后台增加该属性，然后再调用接口进行赋值。详情请参见关于extension参数的使用。手机上最多只能显示10个扩展属性。该字段的值支持链接类型填写，同时链接支持变量通配符自动替换，目前支持通配符有：userid，corpid。例如：工位地址。

senior_mode

boolean

可选

是否开启高管模式：true：开启。开启后，手机号码对所有员工隐藏。普通员工无法对其发DING、发起钉钉免费商务电话。高管之间不受影响。false：不开启。

hired_date

number

可选

入职时间，Unix时间戳，单位毫秒。

login_email

string

登录邮箱。

可选

exclusive_account

boolean

可选

是否专属帐号。为true时，不能指定loginEmail或mobile）。

exclusive_account_type

string

可选

专属帐号类型：sso：企业自建专属帐号dingtalk：钉钉自建专属帐号

loginId

string

可选

钉钉专属帐号登录名。

init_password

string

可选

钉钉专属帐号初始密码。

示例

{
    "extension": "{\"爱好\":\"旅游\"}",
    "mobile": "185xxxx7676",
    "remark": "备注备注",
    "telephone": "010-8xxxxx6-2345",
    "hide_mobile": false,
    "hired_date": 1597573616828,
    "title": "技术总监",
    "userid": "zhangsan",
    "dept_title_list": [
        {
            "dept_id": 2,
            "title": "资深产品经理"
        },
        {
            "dept_id": 3,
            "title": "资深产品经理"
        }
    ],
    "work_place": "未来park",
    "dept_order_list": [
        {
            "dept_id": 2,
            "order": 1
        },
        {
            "dept_id": 3,
            "order": 1
        }
    ],
    "senior_mode": false,
    "org_email": "test@xxx.com",
    "name": "张三",
    "dept_id_list": "2,3",
    "job_number": "4",
    "email": "test@xxx.com"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request POST '/topapi/v2/user/create?access_token={{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "extension": "{\"爱好\":\"旅游\"}",
    "mobile": "185xxxx7676",
    "remark": "备注备注",
    "telephone": "010-8xxxxx6-2345",
    "hide_mobile": false,
    "hired_date": 1597573616828,
    "title": "技术总监",
    "userid": "zhangsan",
    "dept_title_list": [
        {
            "dept_id": 2,
            "title": "资深产品经理"
        },
        {
            "dept_id": 3,
            "title": "资深产品经理"
        }
    ],
    "work_place": "未来park",
    "dept_order_list": [
        {
            "dept_id": 2,
            "order": 1
        },
        {
            "dept_id": 3,
            "order": 1
        }
    ],
    "senior_mode": false,
    "org_email": "test@xxx.com",
    "name": "张三",
    "dept_id_list": "2,3",
    "job_number": "4",
    "email": "test@xxx.com"
}'

返回响应

🟢200成功

application/json

Body

request_id

string

请求ID。

可选

errcode

number

返回码。

可选

errmsg

string

可选

调用失败时返回的错误信息。

result

object

返回结果。

可选

userid

string

可选

员工的userid。

示例

{
    "request_id": "string",
    "errcode": 0,
    "errmsg": "string",
    "result": {
        "userid": "string"
    }
}

说明#

权限#

请求参数

示例代码

返回响应

说明

权限