用户管理 - CreateUser
功能介绍
创建用户
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/csms/users
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| user_name | 是 | String | 用户名,用户唯一标识,企业内唯一。 | 
| mobile | 是 | String | 手机号,企业内唯一。 | 
| password | 否 | String | 密码,需要满足企业定义的格式。 | 
| org_code | 否 | String | 主组织的组织编码,填写企业中存在的组织编码。为空时组织在第一个根组织下。 | 
| name | 否 | String | 姓名,为空值时设置为user_name。可在管理门户界面,用户菜单下的用户属性定义中修改必填属性。 | 
|  | 否 | 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 | 自定义扩展属性。 | 
响应参数
状态码:201
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| user_id | String | 用户id。 | 
状态码:400
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 错误编号。 | 
| error_msg | String | 错误详情。 | 
请求示例
创建一个用户,用户名zhangsan,手机号12345678901,邮箱zhangsan@example.com。
{
  "user_name" : "zhangsan",
  "password" : "p******d",
  "org_code" : "10000",
  "name" : "zhangsan",
  "mobile" : "12345678901",
  "email" : "zhangsan@example.com",
  "employee_id" : "123456789",
  "pwd_must_modify" : false,
  "first_name" : "F",
  "middle_name" : "M",
  "last_name" : "L",
  "attr_gender" : "male",
  "attr_birthday" : "1990-02-01",
  "attr_nick_name" : "zhangsan",
  "attr_identity_type" : "id_card",
  "attr_identity_number" : "123456789",
  "attr_area" : "CN",
  "attr_city" : "xxx",
  "attr_manager_id" : "123456789",
  "attr_user_type" : "regular",
  "attr_hire_date" : "2021-04-01",
  "attr_work_place" : "xxx",
  "user_org_relation_list" : [ {
    "orgCode" : "10000",
    "relationType" : 1
  }, {
    "orgCode" : "TestOrg1",
    "relationType" : 0
  }, {
    "orgCode" : "TestOrg2",
    "relationType" : 0
  } ],
  "extension" : {
    "age" : "18"
  }
}
  响应示例
状态码:201
请求已成功。
{
  "user_id" : "20210621095935811-5E16-6B3060..."
}
  状态码
| 状态码 | 描述 | 
|---|---|
| 201 | 请求已成功。 | 
| 400 | 请求失败。 | 
错误码
请参见错误码。
 
  