创建SSO企业账号

请求

基本信息
HTTP URL	https://api.dingtalk.io/topapi/v2/user/create
HTTP Method	POST
支持的应用类型	appType-企业内部应用
权限要求	permission-qyapi_manage_addresslist-通讯录数据管理权限

查询参数

名称	类型	是否必填	示例值	描述
access_token	String	是	BE3xxxx	调用该接口的应用凭证，通过获取企业内部应用的access_token接口获取。

请求体

名称	类型	是否必填	示例值	描述
userid	String	否	zhangsan	员工唯一标识ID（不可修改），长度为1~64个字符。说明 - 企业内必须唯一。 - 如果不传，将自动生成一个userid。
exclusive_account	Boolean	是	true	必须填true，表示要创建企业账号说明仅适用于企业账号。
exclusive_account_type	String	否	sso	必须填sso，表示SSO企业账号。说明仅适用于SSO企业账号。
name	String	是	张三	员工名称，长度最大80个字符。
dept_id_list	String	是	”2,3,4”	所属部门ID列表，多个部门ID使用`英文,`隔开，每次调用最多传100个部门ID。
telephone	String	否	010-86123456-2345	分机号，长度最大50个字符。说明分机号是唯一的，企业内不能重复。
job_number	String	否	4	员工工号，长度最大为50个字符。
title	String	否	技术总监	职位，长度最大为200个字符。
email	String	否	test@xxx.com	员工个人邮箱，长度最大50个字符。说明员工邮箱是唯一的，企业内不能重复。
org_email	String	否	test@xxx.com	员工的企业邮箱，长度最大100个字符。说明需满足以下条件，此字段才生效：员工已开通企业邮箱。
org_email_type	String	否	profession	员工的企业邮箱类型： - profession: 标准版。 - base：基础版。
work_place	String	否	未来park	办公地点，长度最大100个字符。
remark	String	否	备注信息	备注，长度最大2000个字符。
dept_order_list	Object[]	否		员工在对应的部门中的排序。
dept_id	Number	否	2	部门ID。
order	Number	否	1	员工在部门中的排序，数值越大，排序越靠前。
dept_title_list	Object[]	否		员工在对应的部门中的职位。
dept_id	Number	否	2	部门ID。
title	String	否	资深产品经理	员工在部门中的职位。
extension	Object	否	`{"爱好":"旅游","年龄":"24"}`	扩展属性，可以设置多种属性，最大长度 2000 个字符。说明 - 手机上最多只能显示 10 个扩展属性。 - 在使用该参数前，需要先在钉钉管理后台增加该属性，然后再调用接口进行赋值，例如，在通讯录 > 内部通讯录设置 > 通讯录信息页面，单击添加自定义字段按钮。 - 该字段的值支持链接类型填写，同时链接支持变量通配符自动替换，目前支持通配符有 userid、corpid。例如 `{"爱好":"[爱好](http://www.dingtalk.io?userid=#userid#&corpid=#corpid#)"}`。
senior_mode	Boolean	否	false	是否开启高管模式，默认值false。 - true：开启。说明 - 开启后，手机号码对所有员工隐藏。 - 普通员工无法对其发DING、发起钉钉商务电话。 - 高管之间可以发DING、发起钉钉商务电话。 - false：不开启。
hired_date	Number	否	1597573616828	入职时间，Unix时间戳，单位毫秒。
manager_userid	String	否	001	直属主管的userId。
exclusive_mobile	String	否	+86-13412341234	企业账号手机号。说明仅适用于企业账号。
avatarMediaId	String	否	@lALPDfmVUw19YdrNA-jNA-g	创建本组织企业账号时可指定头像MediaId，只支持jpg/png。可调用上传媒体文件接口获取。说明仅适用于企业账号。
nickname	String	否	昵称	创建本组织企业账号时可指定昵称。说明仅适用于企业账号。

请求示例

curl -X POST "https://api.dingtalk.io/topapi/v2/user/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=871c1df6-bcd5-4acb-b2e9-815b7246d85c' \
-d 'userid=zhangsan'
-d 'exclusive_account=true' \
-d 'name=张三' \
-d 'dept_id_list=2,3,4'

Java

DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/user/create");
OapiV2UserCreateRequest req = new OapiV2UserCreateRequest();
req.setUserid("12345678");
req.setName("sso企业账号");
req.setHideMobile(true);
req.setTelephone("123");
req.setJobNumber("123");
req.setTitle("技术总监");
req.setEmail("test@xxx.com");
req.setOrgEmail("ceshi1");
req.setWorkPlace("北京");
req.setRemark("备注信息");
req.setDeptIdList("486882146,609916162");
OapiV2UserCreateRequest.DeptOrder deptOrder1 = new OapiV2UserCreateRequest.DeptOrder();
deptOrder1.setDeptId(486882146L);
deptOrder1.setOrder(2L);
OapiV2UserCreateRequest.DeptOrder deptOrder2 = new OapiV2UserCreateRequest.DeptOrder();
deptOrder2.setDeptId(609916162L);
deptOrder2.setOrder(1L);
ArrayList<OapiV2UserCreateRequest.DeptOrder> deptOrderList = new ArrayList<>();
deptOrderList.add(deptOrder1);
deptOrderList.add(deptOrder2);
req.setDeptOrderList(deptOrderList);
OapiV2UserCreateRequest.DeptTitle deptTitle1 = new OapiV2UserCreateRequest.DeptTitle();
deptTitle1.setTitle("测试岗位");
deptTitle1.setDeptId(486882146L);
OapiV2UserCreateRequest.DeptTitle deptTitle2 = new OapiV2UserCreateRequest.DeptTitle();
deptTitle2.setTitle("测试负责人");
deptTitle2.setDeptId(609916162L);
ArrayList<OapiV2UserCreateRequest.DeptTitle> deptTitleList = new ArrayList<>();
deptTitleList.add(deptTitle1);
deptTitleList.add(deptTitle2);
req.setDeptTitleList(deptTitleList);
req.setExtension("{\"爱好\":\"旅游\",\"年龄\":\"24\"}");
req.setSeniorMode(false);
req.setHiredDate(1650351000000L);
req.setManagerUserid("001");
req.setOrgEmailType("base");
req.setExclusiveAccount(true);
req.setExclusiveAccountType("sso");
req.setExclusiveMobile("150xxxx");
req.setAvatarMediaId("@lADPDfYH3A-xxx");
req.setNickname("小钉1");
OapiV2UserCreateResponse rsp = client.execute(req, "");
System.out.println(rsp.getBody());

Python

import dingtalk.api

req=dingtalk.api.OapiV2UserCreateRequest("https://api.dingtalk.io/topapi/v2/user/create")
req.userid="zhangsan"
req.name="张三"
req.dept_id_list="2,3,4"
req.exclusive_account=true

try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)

PHP

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiV2UserCreateRequest;
$req->setUserid("zhangsan");
$req->setName("张三");
$req->setDeptIdList("\"2,3,4\"");
$req->setExclusiveAccount("true");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/v2/user/create");

IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/user/create");
OapiV2UserCreateRequest req = new OapiV2UserCreateRequest();
req.Userid = "zhangsan";
req.Name = "张三";
req.ExclusiveAccount = true;
OapiV2UserCreateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

响应

响应体

名称	类型	示例值	描述
errcode	Number	0	错误码。0代表成功。
errmsg	String	ok	错误信息。
result	Object		返回结果。
userid	String	zhangsan	员工id。
unionId	String	xxxx	员工唯一id。

响应体示例

{
  "errcode":"0",
  "result":{
    "unionId":"xxxx",
    "userid":"zhangsan"
  },
  "errmsg":"ok"
}

错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。

API 调用指南

认证与授权

通讯录管理

日程

音视频

AI 表格

文档/文件

即时通信

创建 SSO 企业账号

创建SSO企业账号

请求

查询参数

请求体

请求示例

响应

响应体

响应体示例

错误码

​创建SSO企业账号

​请求

​查询参数

​请求体

​请求示例

​响应

​响应体

​响应体示例

​错误码

创建SSO企业账号

请求

查询参数

请求体

请求示例

响应

响应体

响应体示例

错误码