客户身份(CIAM)

新增用户

# 请求说明

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

# 请求头

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

# 请求示例

{
  	"user_name":"zhangsan",
	"name":"张三",
	"mobile":"+86-15200000000",
	"email":"15200000000@qq.com",
	"pwd":"qwe123!@#",
	"pwd_must_modify":false,
	"attr_gender":"male",
	"attr_birthday":"2022-02-17",
	"attr_nick_name":"张三",
	"mailing_address":"湖北省武汉市",
	"zip_code":"430000",
	"first_name":"",
	"middle_name":"",
	"last_name":"",
	"industry":"事业单位",
	"external_id":"12345678741d29069abcdef089d4q87sk12",
    "head_img": "data:image/jpeg;base64,.......",
	"extension": {
	    "age":"28"
	  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# 请求参数

参数名 中文名称 必须 类型 描述
user_name 用户名 String 用户名,用户在企业内部的唯一标识,可以在请求参数中指定,如果不传该参数,系统将自动生成
name 姓名 String
mobile 手机号 String 手机号支持国际区号,格式为: 区号-手机号
email 邮箱 String
pwd 密码 String 密码需要满足企业定义的格式
pwd_must_modify 强制修改密码 Boolean 下次登录成功时,是否需要强制修改密码。 默认值为true
attr_gender 性别 String 可选值有: "unknow":保密 "male":男 "female":女
attr_birthday 生日 String 格式为: yyyy-mm-dd
attr_nick_name 昵称 String
mailing_address 邮寄地址 String
zip_code 邮政编码 String
first_name 名字 String
middle_name 中间名 String
last_name 姓氏 String
industry 所属行业 String
external_id 外部系统id String 第三方用户id
head_img 用户头像 String 用户头像,支持base 64编码的图片字符串和http、https开头的url
extension 扩展属性 JSONObject 扩展属性,扩展的属性需要在企业中定义

注:企业可根据实际需要在“企业中心-用户属性定义”对系统内置的属性修改是否必填及展示名称(不能删除系统属性),也可以根据企业需求扩展用户属性,接口请求参数以“用户属性定义”模块中定义的属性进行处理。其中自定义的日期属性格式为yyyy-mm-dd。

# 返回示例

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


错误示例:
HTTP/1.1 400 Bad Request
{
  "error_msg": "User not found",
  "error_code": "IDAAS.TENANT.USER.0001"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 返回参数

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

# 错误码

状态码 错误码 错误信息 处理措施
400 IDAAS.TENANT.USER.0001 User not found 请检查对应用户是否存在
用户未找到
400 IDAAS.TENANT.USER.0002 Username cannot be empty 请检查入参中的用户名字段是否为空
用户名不能为空
400 IDAAS.TENANT.USER.0003 Name cannot be empty 请检查入参中的姓名字段是否为空
姓名不能为空
400 IDAAS.TENANT.USER.0004 Mobile number cannot be empty 请检查入参中的手机号字段是否为空
手机号不能为空
400 IDAAS.TENANT.USER.0005 E-mail cannot be empty 请检查入参中的邮箱字段是否为空
邮箱不能为空
400 IDAAS.TENANT.USER.0006 Password cannot be empty 请检查入参中的密码字段是否为空
密码不能为空
400 IDAAS.TENANT.USER.0007 Gender cannot be empty 请检查入参中的性别字段是否为空
性别不能为空
400 IDAAS.TENANT.USER.0008 Birthday cannot be empty 请检查入参中的生日字段是否为空
生日不能为空
400 IDAAS.TENANT.USER.0009 Nick name cannot be empty 请检查入参中的昵称字段是否为空
昵称不能为空
400 IDAAS.TENANT.USER.0010 Mailing address cannot be empty 请检查入参中的邮寄地址字段是否为空
邮寄地址不能为空
400 IDAAS.TENANT.USER.0011 Zip code cannot be empty 请检查入参中的邮政编码字段是否为空
邮政编码不能为空
400 IDAAS.TENANT.USER.0012 First name cannot be empty 请检查入参中的名字字段是否为空
名字不能为空
400 IDAAS.TENANT.USER.0013 Middle name cannot be empty 请检查入参中的中间名字段是否为空
中间名不能为空
400 IDAAS.TENANT.USER.0014 Last name cannot be empty 请检查入参中的姓氏字段是否为空
姓氏不能为空
400 IDAAS.TENANT.USER.0015 Industry cannot be empty 请检查入参中的所属行业字段是否为空
所属行业不能为空
400 IDAAS.TENANT.USER.0016 External ID cannot be empty 请检查入参中的外部ID字段是否为空
外部ID不能为空
400 IDAAS.TENANT.USER.0017 Extended property {0} cannot be empty 请检查入参中的扩展属性{0}字段是否为空
扩展属性{0}不能为空
400 IDAAS.TENANT.USER.0018 The username does not meet the verification rules 请检查入参中的用户名字段是否符合【企业中心-用户-用户属性定义】中用户名字段的校验规则
用户名不符合校验规则
400 IDAAS.TENANT.USER.0019 The name does not meet the verification rules 请检查入参中的姓名字段是否符合【企业中心-用户-用户属性定义】中姓名字段的校验规则
姓名不符合校验规则
400 IDAAS.TENANT.USER.0020 The mobile number does not meet the verification rules 请检查入参中的手机号字段是否符合【企业中心-用户-用户属性定义】中手机号字段的校验规则
手机号不符合校验规则
400 IDAAS.TENANT.USER.0021 The e-mail does not meet the verification rules 请检查入参中的邮箱字段是否符合【企业中心-用户-用户属性定义】中邮箱字段的校验规则
邮箱不符合校验规则
400 IDAAS.TENANT.USER.0023 The gender does not meet the verification rules 请检查入参中的性别字段是否符合【企业中心-用户-用户属性定义】中性别字段的校验规则
性别不符合校验规则
400 IDAAS.TENANT.USER.0024 The birthday does not meet the verification rules 请检查入参中的生日字段是否符合【企业中心-用户-用户属性定义】中生日字段的校验规则
生日不符合校验规则
400 IDAAS.TENANT.USER.0025 The nickname does not meet the verification rules 请检查入参中的昵称字段是否符合【企业中心-用户-用户属性定义】中昵称字段的校验规则
昵称不符合校验规则
400 IDAAS.TENANT.USER.0026 The mailing address does not meet the verification rules 请检查入参中的邮寄地址字段是否符合【企业中心-用户-用户属性定义】中邮寄地址字段的校验规则
邮寄地址不符合校验规则
400 IDAAS.TENANT.USER.0027 The zip code does not meet the verification rules 请检查入参中的邮政编码字段是否符合【企业中心-用户-用户属性定义】中生日字段的校验规则
邮政编码不符合校验规则
400 IDAAS.TENANT.USER.0028 The first name does not meet the verification rules 请检查入参中的名字字段是否符合【企业中心-用户-用户属性定义】中名字字段的校验规则
名字不符合校验规则
400 IDAAS.TENANT.USER.0029 The middle name does not meet the verification rules 请检查入参中的中间名字段是否符合【企业中心-用户-用户属性定义】中中间名字段的校验规则
中间名不符合校验规则
400 IDAAS.TENANT.USER.0030 The last name does not meet the verification rules 请检查入参中的姓氏字段是否符合【企业中心-用户-用户属性定义】中姓氏字段的校验规则
姓氏不符合校验规则
400 IDAAS.TENANT.USER.0031 The industry does not meet the verification rules 请检查入参中的所属行业字段是否符合【企业中心-用户-用户属性定义】中所属行业字段的校验规则
所属行业不符合校验规则
400 IDAAS.TENANT.USER.0032 The external ID does not meet the verification rules 请检查入参中的外部ID字段是否符合【企业中心-用户-用户属性定义】中外部ID字段的校验规则
外部ID不符合校验规则
400 IDAAS.TENANT.USER.0033 The extended attribute {0} does not meet the verification rules 请检查入参中的扩展属性{0}字段是否符合【企业中心-用户-用户属性定义】中扩展属性{0}字段的校验规则
扩展属性{0}不符合校验规则
400 IDAAS.TENANT.MOBILE.0002 An unauthenticated cell mobile number 请检查【企业中心-企业配置-国际区号配置】是否符合配置规则
未经认证的手机号
400 IDAAS.TENANT.USER.0034 Username already exists 请检查用户是否存在
用户名已存在
400 IDAAS.TENANT.USER.0035 Mobile number already exists 删除手机号重新添加或更换未添加过的手机号。
手机号已存在
400 IDAAS.TENANT.USER.0036 E-mail already exists 删除邮箱重新添加或更换未添加过的邮箱。
邮箱已存在
400 IDAAS.TENANT.USER.0037 Extended property {0} already exists 删除扩展属性{0}重新添加或更换未添加过的扩展属性{0}。
扩展属性{0}已存在
400 IDAAS.TENANT.PWD.0001 The password is used before, cannot be used again 请重新输入密码
不允许使用历史密码
400 IDAAS.TENANT.PWD.0002 Password cannot username in reverse order 请重新输入密码
密码不允许使用用户名的倒写
400 IDAAS.TENANT.PWD.0003 Password cannot contain :username, mobile number, email prefix, name in PinYing 请重新输入密码
密码中不允许包含:用户名、手机号、邮箱前缀、姓名拼音
400 IDAAS.TENANT.PWD.0004 Your password complexity is low, {0} 请重新输入密码
密码复杂度低,{0}
400 IDAAS.TENANT.PWD.0005 The password is weak 请重新输入密码
该密码为弱密码
400 IDAAS.TENANT.PWD.0006 Number of character repeat in password should not exceed {0} 请重新输入密码
密码中最大字符重复数不能超过{0}
400 IDAAS.TENANT.PWD.0007 The password must contain {0} to {1} characters 请重新输入密码
密码长度为{0}~{1}个字符