客户身份(CIAM)

使用手机号+短信验证码注册

使用表单注册并且是短信校验时调用本接口。

# 请求说明

POST https://{your_domain}/api/v2/sdk/register/mobile-verify-code

# 请求头

参数名	中文名称	必须	类型	示例
X-operating-sys-version	调用方客户端操作系统版本	是	String	windows10.1.1
X-device-fingerprint	调用方客户端设备指纹	是	String	156aysdna213sc50
X-device-ip	调用方客户端IP	否	String	192.168.1.2
X-agent	User-Agent信息	是	String	Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X)
X-L	用于国际化语言设置	否	String	zh
X-client-id	应用授权ID	是	String	nTo1eRIub60vPb54WeE6aojPwYwImtl4
content-type	内容格式类型	是	String	application/json

# 请求示例

{
	"user_name": "zhangsan",
	"name": "张三",
	"mobile": "15200000000",
	"verify_code": "1234",
	"email": "15200000000@qq.com",
	"pwd": "QWE@qwe123",
	"head_img": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTIQ8QOTSn3y4cYHLlMC3sv6RCBmeMkxtOog47Zr3v2Afbqc2bmP0WibUIUskX39eJlJ",
	"attr_gender": "male",
	"attr_birthday": "1992-02-17",
	"attr_nick_name": "张三",
	"mailing_address": "湖北省武汉市",
	"zip_code": "430000",
	"first_name": "zhangsan",
	"middle_name": "zhangsan",
	"last_name": "zhangsan",
	"industry": "事业单位",
	"extension": {
		"age": "18"
	}
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

注意：除了必填的参数外，其他参数需要参考IDaaS用户属性定义中字段是否必填配置

# 请求参数

参数名	中文名称	必须	类型	描述
user_name	用户名	否	String
name	姓名	否	String
mobile	手机号	是	String
verify_code	短信验证码	是	String	获取验证码请参考发送短信验证码接口 type=REGISTER_SMS
email	邮箱	否	String
pwd	密码	否	String
head_img	头像（url）	否	String
attr_gender	性别	否	String	可选值有： female：女性； male：男性； unknow：保密
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
extension	扩展属性	否	JSONObject	扩展的属性需要在企业中定义

# 返回示例

成功示例：
HTTP/1.1 200 OK
Content-Type: application/json
{
    "status": "SUCCESS",
    "expire": 43200,
    "session_token": "LGTiTNVDFPlpefV3F3Hla7RUFTqInsqa",
    "id_token": "eyJ0NiJ9.eyJ1cI6IjIifX0.DeWt4QuZXso"
}

错误示例：
HTTP/1.1 400 Bad Request
{
    "error_code": "IDAAS.SDK.USER.0035",
    "error_msg": "Phone number already exists"
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 返回参数

参数名	中文名称	类型	描述
status	返回结果	String	该字段可能返回的值如下： SUCCESS 登录成功 ACCESS_DENIED 拒绝访问
expire	session_token有效期	Number	session_token有效期，有效期内可使用session_token获取ticket
session_token	用户session_token	String	用户session_token，可使用该token调用IDaaS接口获取sso_ticket，sso_ticket可以换取用户信息
id_token	短期有效，接口调用令牌	String	该字段为jwt格式，包含用户身份信息。可参考根据id_token获取用户信息获取用户信息。令牌有效期默认为5分钟，支持可配置

# 错误码

状态码	错误码	错误信息	处理措施
400	IDAAS.SDK.PARAM.0001	Device information is incomplete	请检查输入的设备信息是否完整
		设备信息不完整
400	IDAAS.SDK.PARAM.0002	clientId cannot be empty	请检查输入的clientId是否为空
		clientId不能为空
400	IDAAS.SDK.PARAM.0003	The app is not registered, please register the app first	请检查输入的clientId是否正确
		应用未注册，请先注册应用
400	IDAAS.SDK. PARAM.0009	Verification code cannot be empty	请检查输入的验证码是否为空
		验证码不能为空
400	IDAAS.SDK.USER.0004	Mobile number cannot be empty	请检查输入的手机号是否为空
		手机号不能为空
400	IDAAS.SDK.CAPTCHA.0007	Incorrect verification code	请检查输入的验证码是否正确
		验证码不正确
400	IDAAS.SDK.USER.0002	Username cannot be empty	请检查入参中的用户名字段是否为空
		用户名不能为空
400	IDAAS.SDK.USER.0003	Name cannot be empty	请检查入参中的姓名字段是否为空
		姓名不能为空
400	IDAAS.SDK.USER.0005	E-mail cannot be empty	请检查入参中的邮箱字段是否为空
		邮箱不能为空
400	IDAAS.SDK.USER.0007	Gender cannot be empty	请检查入参中的性别字段是否为空
		性别不能为空
400	IDAAS.SDK.USER.0008	Birthday cannot be empty	请检查入参中的生日字段是否为空
		生日不能为空
400	IDAAS.SDK.USER.0009	Nick name cannot be empty	请检查入参中的昵称字段是否为空
		昵称不能为空
400	IDAAS.SDK.USER.0010	Mailing address cannot be empty	请检查入参中的邮寄地址字段是否为空
		邮寄地址不能为空
400	IDAAS.SDK.USER.0011	Zip code cannot be empty	请检查入参中的邮政编码字段是否为空
		邮政编码不能为空
400	IDAAS.SDK.USER.0012	First name cannot be empty	请检查入参中的名字字段是否为空
		名字不能为空
400	IDAAS.SDK.USER.0013	Middle name cannot be empty	请检查入参中的中间名字段是否为空
		中间名不能为空
400	IDAAS.SDK.USER.0014	Last name cannot be empty	请检查入参中的姓氏字段是否为空
		姓氏不能为空
400	IDAAS.SDK.USER.0015	Industry cannot be empty	请检查入参中的所属行业字段是否为空
		所属行业不能为空
400	IDAAS.SDK.USER.0017	Extended property {0} cannot be empty	请检查入参中的扩展属性{0}字段是否为空
		扩展属性{0}不能为空
400	IDAAS.SDK.USER.0018	The username does not meet the verification rules	请检查入参中的用户名字段是否符合【企业中心-用户-用户属性定义】中用户名字段的校验规则
		用户名不符合校验规则
400	IDAAS.SDK.USER.0019	The name does not meet the verification rules	请检查入参中的姓名字段是否符合【企业中心-用户-用户属性定义】中姓名字段的校验规则
		姓名不符合校验规则
400	IDAAS.SDK.USER.0020	The phone number does not meet the verification rules	请检查入参中的手机号字段是否符合【企业中心-用户-用户属性定义】中手机号字段的校验规则
		手机号不符合校验规则
400	IDAAS.SDK.USER.0021	The e-mail does not meet the verification rules	请检查入参中的邮箱字段是否符合【企业中心-用户-用户属性定义】中邮箱字段的校验规则
		邮箱不符合校验规则
400	IDAAS.SDK.USER.0023	The gender does not meet the verification rules	请检查入参中的性别字段是否符合【企业中心-用户-用户属性定义】中性别字段的校验规则
		性别不符合校验规则
400	IDAAS.SDK.USER.0024	The birthday does not meet the verification rules	请检查入参中的生日字段是否符合【企业中心-用户-用户属性定义】中生日字段的校验规则
		生日不符合校验规则
400	IDAAS.SDK.USER.0025	The nickname does not meet the verification rules	请检查入参中的昵称字段是否符合【企业中心-用户-用户属性定义】中昵称字段的校验规则
		昵称不符合校验规则
400	IDAAS.SDK.USER.0026	The mailing address does not meet the verification rules	请检查入参中的邮寄地址字段是否符合【企业中心-用户-用户属性定义】中邮寄地址字段的校验规则
		邮寄地址不符合校验规则
400	IDAAS.SDK.USER.0027	The zip code does not meet the verification rules	请检查入参中的邮政编码字段是否符合【企业中心-用户-用户属性定义】中生日字段的校验规则
		邮政编码不符合校验规则
400	IDAAS.SDK.USER.0028	The first name does not meet the verification rules	请检查入参中的名字字段是否符合【企业中心-用户-用户属性定义】中名字字段的校验规则
		名字不符合校验规则
400	IDAAS.SDK.USER.0029	The middle name does not meet the verification rules	请检查入参中的中间名字段是否符合【企业中心-用户-用户属性定义】中中间名字段的校验规则
		中间名不符合校验规则
400	IDAAS.SDK.USER.0030	The last name does not meet the verification rules	请检查入参中的姓氏字段是否符合【企业中心-用户-用户属性定义】中姓氏字段的校验规则
		姓氏不符合校验规则
400	IDAAS.SDK.USER.0031	The industry does not meet the verification rules	请检查入参中的所属行业字段是否符合【企业中心-用户-用户属性定义】中所属行业字段的校验规则
		所属行业不符合校验规则
400	IDAAS.SDK.USER.0033	The extended attribute {0} does not meet the verification rules	请检查入参中的扩展属性{0}字段是否符合【企业中心-用户-用户属性定义】中扩展属性{0}字段的校验规则
		扩展属性{0}不符合校验规则
400	IDAAS.SDK.MOBILE.0002	An unauthenticated cell phone number	请检查【企业中心-企业配置-国际区号配置】是否符合配置规则
		未经认证的手机号
400	IDAAS.SDK.USER.0034	Username already exists	请检查用户是否存在
		用户名已存在
400	IDAAS.SDK.USER.0035	Phone number already exists	删除手机号重新添加或更换未添加过的手机号。
		手机号已存在
400	IDAAS.SDK.USER.0036	Email already exists	删除邮箱重新添加或更换未添加过的邮箱。
		邮箱已存在
400	IDAAS.SDK.USER.0037	Extended property {0} already exists	删除扩展属性{0}重新添加或更换未添加过的扩展属性{0}。
		扩展属性{0}已存在

支付宝登录使用邮箱+验证码注册

竹云IDaaS•开放平台

使用手机号+短信验证码注册

使用手机号+短信验证码注册

# 请求说明

# 请求头

# 请求示例

# 请求参数

# 返回示例

# 返回参数

# 错误码