竹云IDaaS•开放平台
员工身份(EIAM)

新增用户

接口

# 权限

身份管理API是以应用维度授权的，在调用接口前需为不同的应用设置接口权限，详情请参考API权限。

权限代码 描述
user_all 用户管理接口的读写权限
all 全部接口读写权限

# 请求说明

POST https://{your_domain}/api/v2/tenant/users

# 请求头

参数名 中文名称 必须 类型 描述
Authorization 授权 是 String 格式：Bearer {access_token}
Content-Type 内容类型 是 String 固定值：application/json; charset=utf-8

# 请求示例1（没有启用岗位时使用）

{ 
	"user_name": "cq04130004",
    "org_code": "10000",
    "name": "cq04130004",
    "mobile": "+86-15204130004",
    "email": "15204130004@example.com",
    "employee_id": "04130004",
    "external_id": "04130004",
    "first_name": "F",
    "middle_name": "M",
    "last_name": "L",
    "password": "P@ssw0rd",
    "pwd_must_modify":false,
    "attr_gender":"male",
    "attr_birthday":"1993-08-25",
    "attr_nick_name":"cq04130004",
    "attr_manager_id": "20240531140530566-8F29-6EC1BBEF1",
    "user_org_relation_list": [
        {
            "org_code": "10000",
            "relation_type": 1
        },
        {
            "org_code": "TestOrg1",
            "relation_type": 0
        },
        {
            "org_code": "TestOrg2",
            "relation_type": 0
        }
    ],
    "extension": {
        "age": "18"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# 请求示例2（启用岗位后使用）

{ 
	"user_name": "cq04130004",
    "org_code": "10000",
    "name": "cq04130004",
    "mobile": "+86-15204130004",
    "email": "15204130004@example.com",
    "employee_id": "04130004",
    "external_id": "04130004",
    "first_name": "F",
    "middle_name": "M",
    "last_name": "L",
    "password": "P@ssw0rd",
    "pwd_must_modify":false,
    "attr_gender":"male",
    "attr_birthday":"1993-08-25",
    "attr_nick_name":"cq04130004",
    "jobs": [
        {
            "org_code": "10000",
            "position_code": "IDaaS_Java_Developer",
            "title_code": "Senior_Engineer",
            "relation_type": 1
        },
        {
            "org_code": "TestOrg1",
            "position_code": "TestOrg1_Java_Developer",
            "title_code": "Senior_Engineer",
            "relation_type": 0
        },
        {
            "org_code": "TestOrg2",
            "position_code": "TestOrg2_Java_Developer",
            "title_code": "Senior_Engineer",
            "relation_type": 0
        }
    ],
    "extension": {
        "age": "18"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

user_name、name、mobile、email、employee_id、external_id、first_name、middle_name、last_name、attr_gender、attr_birthday、attr_nick_name属性是否必填都可以在IDaaS企业中心 > 用户属性定义中进行配置。

# 请求参数

参数名 中文名称 必须 类型 描述
user_name 用户名 是 String 用户名，系统唯一
org_code 组织code 否 String 为空时默认在第一个根组织下
name 姓名 否 String 姓名
mobile 手机号 是 String 手机号，系统唯一
email 邮箱 否 String 邮箱，系统唯一
employee_id 员工工号 否 String 员工工号
external_id 外部系统ID 否 String 外部系统ID，系统唯一
password 密码 否 String 密码需要满足企业定义的格式
pwd_must_modify 强制修改密码 否 Boolean true代表第一次登录需要修改密码，false代表第一次登录不需要修改密码
first_name 名字 否 String
middle_name 中间名 否 String
last_name 姓氏 否 String
attr_gender 性别 否 String 可选值有： "unknow":保密 "male":男 "female":女
attr_birthday 生日 否 String 格式为： yyyy-mm-dd
attr_nick_name 昵称 否 String
attr_manager_id 直属上级ID 否 String 上级用户id
user_org_relation_list 用户组织关系集合 否 JSONArray 仅在未开启任职管理时使用，不能和jobs同时存在。 org_code：组织code；relation_type：1代表归属，0代表挂靠
jobs 用户的岗位信息集合 否 JSONArray 仅在开启任职管理之后使用，不能和user_org_relation_list同时存在。org_code：组织code；position_code：职位编码；title_code：职务编码；relation_type：1代表所属机构的主岗，0代表兼职兼岗
extension 扩展属性 否 JSONObject 扩展属性，扩展的属性需要在企业中定义

# 返回示例

成功示例： 
HTTP/1.1 201 Created 
Content-Type: application/json 
{ 
    "user_id": "20201028102749564-9082-DC8CD2722" 
} 

错误示例： 
HTTP/1.1 400 Bad Request 
{ 
    "error_code": "ORG.0001", 
    "error_msg": "组织不存在" 
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# 返回参数

参数名 中文名称 类型 描述
user_id 创建的用户user_id String 系统自动生成

# 错误码

状态码 错误码 错误信息 处理措施
400 ORG.0001 组织不存在 请检查对应组织是否存在
Organization does not exist
400 ORG.0010 组织ID不能为空 请检查入参中的组织ID字段是否为空
Organization ID cannot be empty
400 JOB.POSITION.0001 职位不存在 请检查对应职位是否存在
Position does not exist
400 JOB.TITLE.0001 职务不存在 请检查对应职务是否存在
Job title does not exist
400 USER.0009 用户名不能为空 请检查入参中的用户名字段是否为空
Username cannot be empty
400 USER.0010 姓名不能为空 请检查入参中的姓名字段是否为空
Name cannot be empty
400 USER.0011 手机号不能为空 请检查入参中的手机号字段是否为空
Mobile number cannot be empty
400 USER.0012 邮箱不能为空 请检查入参中的邮箱字段是否为空
Email cannot be empty
400 USER.0013 名字不能为空 请检查入参中的名字字段是否为空
Name cannot be empty
400 USER.0014 中间名不能为空 请检查入参中的中间名字段是否为空
Middle name cannot be empty
400 USER.0015 姓氏不能为空 请检查入参中的姓氏字段是否为空
Last name cannot be empty
400 USER.0016 昵称不能为空 请检查入参中的昵称字段是否为空
Nickname cannot be empty
400 USER.0017 生日不能为空 请检查入参中的生日字段是否为空
Birthday cannot be empty
400 USER.0018 性别不能为空 请检查入参中的性别字段是否为空
Gender cannot be empty
400 USER.0019 证件类型不能为空 请检查入参中的证件类型字段是否为空
Identity type cannot be empty
400 USER.0020 证件号码不能为空 请检查入参中的证件号码字段是否为空
The ID number cannot be empty
400 USER.0021 国家或地区不能为空 请检查入参中的国家或地区字段是否为空
Country or area cannot be empty
400 USER.0022 城市不能为空 请检查入参中的城市字段是否为空
City cannot be empty
400 USER.0023 工号不能为空 请检查入参中的工号字段是否为空
Employer ID cannot be empty
400 USER.0024 外部系统ID不能为空 请检查入参中的外部系统ID字段是否为空
The external system ID cannot be empty
400 USER.0025 直属上级不能为空 请检查入参中的直属上级字段是否为空
The direct superior cannot be empty
400 USER.0026 人员类型不能为空 请检查入参中的人员类型字段是否为空
Person type cannot be empty
400 USER.0027 入职时间不能为空 请检查入参中的入职时间字段是否为空
Hire date cannot be empty
400 USER.0028 工作所在地不能为空 请检查入参中的工作所在地字段是否为空
Work location cannot be empty
400 USER.0029 扩展属性[{0}]不能为空 请检查入参中的扩展属性[{0}]字段是否为空
Extension property [{0}] cannot be empty
400 USER.0030 用户名已存在 当前用户名已存在，请更换为其他不存在的值
Username already exists
400 USER.0031 手机号已存在 当前手机号已存在，请更换为其他不存在的值
Mobile number already exists
400 USER.0032 邮箱已存在 当前邮箱已存在，请更换为其他不存在的值
Email already exists
400 USER.0033 证件号码已存在 当前证件号码已存在，请更换为其他不存在的值
The ID number already exists
400 USER.0034 工号已存在 当前工号已存在，请更换为其他不存在的值
The employee ID already exists
400 USER.0035 外部系统ID已存在 当前外部属性ID已存在，请更换为其他不存在的值
External System ID already exists
400 USER.0036 扩展属性[{0}]已存在 当前扩展属性[{0}]已存在，请更换为其他不存在的值
Extension attribute [{0}] already exists
400 USER.0037 用户名不符合校验规则 请检查入参中的用户名字段是否符合【企业中心-用户-用户属性定义】中的校验规则
Username does not meet the verification rules
400 USER.0038 姓名不符合校验规则 请检查入参中的姓名字段是否符合【企业中心-用户-用户属性定义】中的校验规则
Name does not meet verification rules
400 USER.0039 手机号不符合校验规则 请检查入参中的手机号字段是否符合【企业中心-用户-用户属性定义】中的校验规则
The mobile phone number does not meet the verification rules
400 USER.0040 邮箱不符合校验规则 请检查入参中的邮箱字段是否符合【企业中心-用户-用户属性定义】中的校验规则
Email does not meet the verification rules
400 USER.0041 名字不符合校验规则 请检查入参中的名字字段是否符合【企业中心-用户-用户属性定义】中的校验规则
The name does not meet the verification rules
400 USER.0042 中间名不符合校验规则 请检查入参中的中间名字段是否符合【企业中心-用户-用户属性定义】中的校验规则
Middle name does not meet the verification rules
400 USER.0043 姓氏不符合校验规则 请检查入参中的姓氏字段是否符合【企业中心-用户-用户属性定义】中的校验规则
Last name does not meet verification rules
400 USER.0044 昵称不符合校验规则 请检查入参中的昵称字段是否符合【企业中心-用户-用户属性定义】中的校验规则
Nickname does not meet the verification rules
400 USER.0045 生日不符合校验规则 请检查入参中的生日字段是否符合【企业中心-用户-用户属性定义】中的校验规则
Birthday does not meet verification rules
400 USER.0046 性别不符合校验规则 请检查入参中的性别字段是否符合【企业中心-用户-用户属性定义】中的校验规则
Gender does not meet the verification rules
400 USER.0047 证件类型不符合校验规则 请检查入参中的证件类型字段是否符合【企业中心-用户-用户属性定义】中的校验规则
The ID type does not meet the verification rules
400 USER.0048 证件号码不符合校验规则 请检查入参中的证件号码字段是否符合【企业中心-用户-用户属性定义】中的校验规则
The ID number does not meet the verification rules
400 USER.0049 国家或地区不符合校验规则 请检查入参中的国家和地区字段是否符合【企业中心-用户-用户属性定义】中的校验规则
Country or region does not meet verification rules
400 USER.0050 城市不符合校验规则 请检查入参中的城市字段是否符合【企业中心-用户-用户属性定义】中的校验规则
City does not meet verification rules
400 USER.0051 工号不符合校验规则 请检查入参中的工号字段是否符合【企业中心-用户-用户属性定义】中的校验规则
The employee ID does not meet the verification rules
400 USER.0052 外部系统ID不符合校验规则 请检查入参中的外部系统ID字段是否符合【企业中心-用户-用户属性定义】中的校验规则
The external system ID does not meet the verification rules
400 USER.0053 直属上级不符合校验规则 请检查入参中的直属上级字段是否符合【企业中心-用户-用户属性定义】中的校验规则
The immediate superior does not meet the verification rules
400 USER.0054 人员类型不符合校验规则 请检查入参中的人员类型字段是否符合【企业中心-用户-用户属性定义】中的校验规则
The person type does not meet the verification rules
400 USER.0055 入职时间不符合校验规则 请检查入参中的入职时间字段是否符合【企业中心-用户-用户属性定义】中的校验规则
Job date does not meet verification rules
400 USER.0056 工作所在地不符合校验规则 请检查入参中的工作所在地字段是否符合【企业中心-用户-用户属性定义】中的校验规则
Work location does not meet verification rules
400 USER.0057 扩展属性[{0}]不符合校验规则 请检查入参中的扩展属性[{0}]字段是否符合【企业中心-用户-用户属性定义】中的校验规则
Extension property [{0}] does not meet verification rules
400 USER.0080 用户的组织不能超过{0}个 请修改入参中用户的组织的个数
User cannot have more than {0} organizations
400 USER.0081 用户只能有一个主组织 请修改入参中用户的主组织的个数
Users can only have one primary organization
400 USER.00811 用户主组织/主岗不存在 请检查参数中是否有主组织/主岗的数据
The user's main organization does not exist
400 USER.0082 用户身上的组织必须和关系中的主组织一致 请检查用户身上的组织是否和用户组织关系参数中的主组织一致
The organization on the user must match the primary organization in the relationship
400 USER.0083 不支持的用户组织关系类型 请检查入参中的用户组织关系类型参数是否正确
Unsupported user organization relation type
400 USER.0085 用户数量不能超过规格限制 请联系管理员升级企业用户规格数量
The number of users cannot exceed the specification limit
400 USER.0094 用户任职信息中的组织不能为空 请填写岗位信息中的组织
The organization in the user's employment information cannot be empty
400 USER.0095 用户任职信息中的职位不能为空 请填写岗位信息中的职位
The position in the user's employment information cannot be empty
400 USER.0096 用户任职信息中的职务不能为空 请填写岗位信息中的职务
The job title in the user's employment information cannot be empty
400 USER.0097 用户任职信息中的职位不在所选组织下 请检查岗位信息中的职职位是否在对对应的组织下
The position in the user's job information is not under the selected organization

修改用户