client/docs/passport/login.md

102 lines
2.4 KiB
Markdown

# Login
Passport-通行证模块-登录
- [/passport.Login/Pwd](#passportloginpwd)
- [/passport.Login/Code](#passportlogincode)
- [/passport.Login/CodeAndRegister](#passportlogincodeandregister)
## /passport.Login/Pwd
通过密码登录
### Request
```javascript
{
account: "", // type<string>, 账号 必填
password: "", // type<string>, 密码 必填
}
```
### Reply
```javascript
{
id: "0", // type<int64>
identity: "", // type<string>, 用户唯一码
token: "", // type<string>, 用户凭证
extend: {
"": ""
}, // map<string,string>, 扩展字段
verify_status: {
email_verify: false, // type<bool>, 邮箱是否已验证
phone_verify: false, // type<bool>, 手机是否已验证
photo_verify: false, // type<bool>, 头像是否已验证
kyc_verify: false, // type<bool>, 实名是否已验证
}, // type<VerifyStatus>, 用户验证状态
}
```
## /passport.Login/Code
通过验证码登录
### Request
```javascript
{
country: "", // type<string>, 国家
phone: "", // type<string>, 手机号码
code: "", // type<string>, 验证码
}
```
### Reply
```javascript
{
id: "0", // type<int64>
identity: "", // type<string>, 用户唯一码
token: "", // type<string>, 用户凭证
extend: {
"": ""
}, // map<string,string>, 扩展字段
verify_status: {
email_verify: false, // type<bool>, 邮箱是否已验证
phone_verify: false, // type<bool>, 手机是否已验证
photo_verify: false, // type<bool>, 头像是否已验证
kyc_verify: false, // type<bool>, 实名是否已验证
}, // type<VerifyStatus>, 用户验证状态
}
```
## /passport.Login/CodeAndRegister
通过验证码登录并注册
### Request
```javascript
{
country: "", // type<string>, 国家
phone: "", // type<string>, 手机号码
code: "", // type<string>, 验证码
}
```
### Reply
```javascript
{
id: "0", // type<int64>
identity: "", // type<string>, 用户唯一码
token: "", // type<string>, 用户凭证
extend: {
"": ""
}, // map<string,string>, 扩展字段
verify_status: {
email_verify: false, // type<bool>, 邮箱是否已验证
phone_verify: false, // type<bool>, 手机是否已验证
photo_verify: false, // type<bool>, 头像是否已验证
kyc_verify: false, // type<bool>, 实名是否已验证
}, // type<VerifyStatus>, 用户验证状态
}
```