Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
unidocs-zh
提交
15d58ca9
unidocs-zh
项目概览
DCloud
/
unidocs-zh
通知
3172
Star
105
Fork
804
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
93
列表
看板
标记
里程碑
合并请求
67
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
93
Issue
93
列表
看板
标记
里程碑
合并请求
67
合并请求
67
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
15d58ca9
编写于
10月 17, 2022
作者:
C
chenruilong
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
docs: update uni-id-pages.md
上级
8515708e
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
106 addition
and
20 deletion
+106
-20
docs/uniCloud/uni-id-pages.md
docs/uniCloud/uni-id-pages.md
+106
-20
未找到文件。
docs/uniCloud/uni-id-pages.md
浏览文件 @
15d58ca9
...
@@ -83,11 +83,11 @@
...
@@ -83,11 +83,11 @@
│ │ │ ├─login-withoutpwd.vue 免密码登录
│ │ │ ├─login-withoutpwd.vue 免密码登录
│ │ │ └─login-withpwd.vue 密码登录
│ │ │ └─login-withpwd.vue 密码登录
│ │ ├─register
│ │ ├─register
│ │ │ ├─register.vue 通过用户名密码注册账号
│ │ │ ├─register.vue 通过用户名密码注册账号
│ │ │ ├─register-by-email.vue 通过邮箱验证码注册账号
│ │ │ ├─register-by-email.vue 通过邮箱验证码注册账号
│ │ │ └─validator.js 注册账号页的表单验证规则文件
│ │ │ └─validator.js 注册账号页的表单验证规则文件
│ │ ├─retrieve
│ │ ├─retrieve
│ │ │ ├─retrieve-by-email.vue 通过邮箱验证码重置密码
│ │ │ ├─retrieve-by-email.vue 通过邮箱验证码重置密码
│ │ │ └─retrieve.vue 通过手机验证码重置密码
│ │ │ └─retrieve.vue 通过手机验证码重置密码
│ │ └─userinfo
│ │ └─userinfo
│ │ ├─bind-mobile.vue 绑定手机号码
│ │ ├─bind-mobile.vue 绑定手机号码
...
@@ -256,9 +256,9 @@ export default {
...
@@ -256,9 +256,9 @@ export default {
|字段 |类型 |描述 |
|字段 |类型 |描述 |
|-- |-- |-- |
|-- |-- |-- |
|为空或false| - |不验证密码强度 |
|为空或false| - |不验证密码强度 |
|super |String |超强:密码必须包含大小写字母、数字和特殊符号,长度范围:8-16位之间 |
|super |String |超强:密码必须包含大小写字母、数字和特殊符号,长度范围:8-16位之间 |
|strong |String |强: 密密码必须包含字母、数字和特殊符号,长度范围:8-16位之间 |
|strong |String |强: 密密码必须包含字母、数字和特殊符号,长度范围:8-16位之间 |
|medium |String |中:密码必须为字母、数字和特殊符号任意两种的组合,长度范围:8-16位之间|
|medium |String |中:密码必须为字母、数字和特殊符号任意两种的组合,长度范围:8-16位之间|
|weak |String |弱:密码必须包含字母和数字,长度范围:6-16位之间 |
|weak |String |弱:密码必须包含字母和数字,长度范围:6-16位之间 |
## 页面介绍
## 页面介绍
...
@@ -336,7 +336,7 @@ const uniIdCo = uniCloud.importObject('uni-id-co')
...
@@ -336,7 +336,7 @@ const uniIdCo = uniCloud.importObject('uni-id-co')
|uniIdCo.authorizeAppLogin() |授权用户登录应用
[
详情
](
#authorize-app-login
)
|
|uniIdCo.authorizeAppLogin() |授权用户登录应用
[
详情
](
#authorize-app-login
)
|
|uniIdCo.removeAuthorizedApp() |移除用户登录授权
[
详情
](
#remove-authorized-app
)
|
|uniIdCo.removeAuthorizedApp() |移除用户登录授权
[
详情
](
#remove-authorized-app
)
|
|uniIdCo.setAuthorizedApp() |设置用户允许登录的应用列表
[
详情
](
#set-authorized-app
)
|
|uniIdCo.setAuthorizedApp() |设置用户允许登录的应用列表
[
详情
](
#set-authorized-app
)
|
|uniIdCo.registerUser() |注册普通用户
[
详情
](
#register-user
)
|
|uniIdCo.registerUser() |注册普通用户
[
详情
](
#register-user
)
|
|uniIdCo.registerUserByEmail() |通过邮箱验证码注册普通用户
[
详情
](
#register-user-by-email
)
|
|uniIdCo.registerUserByEmail() |通过邮箱验证码注册普通用户
[
详情
](
#register-user-by-email
)
|
|uniIdCo.login() |用户名密码登录
[
详情
](
#login
)
|
|uniIdCo.login() |用户名密码登录
[
详情
](
#login
)
|
|uniIdCo.loginBySms() |短信验证码登录
[
详情
](
#login-by-sms
)
|
|uniIdCo.loginBySms() |短信验证码登录
[
详情
](
#login-by-sms
)
|
...
@@ -354,13 +354,13 @@ const uniIdCo = uniCloud.importObject('uni-id-co')
...
@@ -354,13 +354,13 @@ const uniIdCo = uniCloud.importObject('uni-id-co')
|uniIdCo.bindAlipay() |绑定支付宝账号
[
详情
](
#bind-alipay
)
|
|uniIdCo.bindAlipay() |绑定支付宝账号
[
详情
](
#bind-alipay
)
|
|uniIdCo.bindApple() |绑定苹果账号
[
详情
](
#bind-apple
)
|
|uniIdCo.bindApple() |绑定苹果账号
[
详情
](
#bind-apple
)
|
|uniIdCo.updatePwd() |更新密码
[
详情
](
#update-pwd
)
|
|uniIdCo.updatePwd() |更新密码
[
详情
](
#update-pwd
)
|
|uniIdCo.resetPwdBySms() |通过短信验证码重置密码
[
详情
](
#reset-pwd-by-sms
)
|
|uniIdCo.resetPwdBySms() |通过短信验证码重置密码
[
详情
](
#reset-pwd-by-sms
)
|
|uniIdCo.resetPwdByEmail() |通过邮箱验证码重置密码
[
详情
](
#reset-pwd-by-email
)
|
|uniIdCo.resetPwdByEmail() |通过邮箱验证码重置密码
[
详情
](
#reset-pwd-by-email
)
|
|uniIdCo.closeAccount() |注销账户
[
详情
](
#close-account
)
|
|uniIdCo.closeAccount() |注销账户
[
详情
](
#close-account
)
|
|uniIdCo.getAccountInfo() |获取账户账户简略信息
[
详情
](
#get-account-info
)
|
|uniIdCo.getAccountInfo() |获取账户账户简略信息
[
详情
](
#get-account-info
)
|
|uniIdCo.createCaptcha() |创建图形验证码
[
详情
](
#create-captcha
)
|
|uniIdCo.createCaptcha() |创建图形验证码
[
详情
](
#create-captcha
)
|
|uniIdCo.refreshCaptcha() |刷新图形验证码
[
详情
](
#refresh-captcha
)
|
|uniIdCo.refreshCaptcha() |刷新图形验证码
[
详情
](
#refresh-captcha
)
|
|uniIdCo.sendSmsCode() |发送短信验证码
[
详情
](
#send-sms-code
)
|
|uniIdCo.sendSmsCode() |发送短信验证码
[
详情
](
#send-sms-code
)
|
|uniIdCo.sendEmailCode() |发送邮箱验证码
[
详情
](
#send-email-code
)
|
|uniIdCo.sendEmailCode() |发送邮箱验证码
[
详情
](
#send-email-code
)
|
|uniIdCo.refreshToken() |刷新token
[
详情
](
#refresh-token
)
|
|uniIdCo.refreshToken() |刷新token
[
详情
](
#refresh-token
)
|
|uniIdCo.acceptInvite() |接受邀请
[
详情
](
#accept-invite
)
|
|uniIdCo.acceptInvite() |接受邀请
[
详情
](
#accept-invite
)
|
...
@@ -436,8 +436,8 @@ await uniIdCo.registerUser({
...
@@ -436,8 +436,8 @@ await uniIdCo.registerUser({
|errMsg |string |错误信息 |
|errMsg |string |错误信息 |
|newToken |object |token信息 |
|newToken |object |token信息 |
|
|
-
token |string |token |
|
|
-
token |string |token |
|
|
-
tokenExpired|string |token过期时间 |
|
|
-
tokenExpired|string |token过期时间 |
#### 邮箱验证码注册用户@register-user-by-email
#### 邮箱验证码注册用户@register-user-by-email
**接口形式**
**接口形式**
...
@@ -538,6 +538,34 @@ await uniIdCo.loginBySms({
...
@@ -538,6 +538,34 @@ await uniIdCo.loginBySms({
|
|
-
token |string |token |
|
|
-
token |string |token |
|
|
-
tokenExpired|string |token过期时间 |
|
|
-
tokenExpired|string |token过期时间 |
#### 微信授权手机号登录@login-by-weixin-mobile <Badge text="uni-id-co 1.0.25+" />
**接口形式**
```
js
await
uniIdCo
.
loginByWeixinMobile
({
phoneCode
,
inviteCode
})
```
**参数说明**
|参数名 |类型 |必填 |说明 |
|-- |-- |-- |-- |
|phoneCode |string |是 |getPhoneNumber 事件回调获取到动态令牌code |
|inviteCode |string |否 |邀请码,仅注册时生效 |
**返回值**
|参数名 |类型 |说明 |
|-- |-- |-- |
|errCode |string
|
number |错误码 |
|errMsg |string |错误信息 |
|newToken |object |token信息 |
|
|
-
token |string |token |
|
|
-
tokenExpired|string |token过期时间 |
#### 一键登录@login-by-univerify
#### 一键登录@login-by-univerify
手机号已存在时登录,否则注册
手机号已存在时登录,否则注册
...
@@ -907,18 +935,29 @@ await uniIdCo.bindMobileByUniverify({
...
@@ -907,18 +935,29 @@ await uniIdCo.bindMobileByUniverify({
#### 通过微信绑定手机号@bind-mobile-by-mp-weixin
#### 通过微信绑定手机号@bind-mobile-by-mp-weixin
使用此接口时务必注意,微信小程序的规则是客户端应先使用checkSession接口检测上次获取的sessionKey是否仍有效。
::: warning 使用此接口时务必注意
**微信小程序对获取手机号的接口进行了安全升级,自 `uni-id-co@1.0.25` 以上版本开始,支持getPhoneNumber事件回调的动态口令`code`,同时为了向下兼容保留`encryptedData` 与 `iv`参数,建议开发者升级,以增强小程序安全性。**
微信小程序的规则是客户端应先使用checkSession接口检测上次获取的sessionKey是否仍有效。
如果有效则直接使用上次存储的sessionKey即可,如果无效应重新调用login接口再次刷新sessionKey。
如果有效则直接使用上次存储的sessionKey即可,如果无效应重新调用login接口再次刷新sessionKey。
微信小程序登录、绑定小程序微信账号时会自动更新用户的sessionKey。
微信小程序登录、绑定小程序微信账号时会自动更新用户的sessionKey。
:::
**接口形式**
**接口形式**
```
js
```
js
// uni-id-co >= 1.0.25
await
uniIdCo
.
bindMobileByMpWeixin
({
await
uniIdCo
.
bindMobileByMpWeixin
({
encryptedData
,
code
iv
})
// uni-id-co < 1.0.25
await
uniIdCo
.
bindMobileByMpWeixin
({
encryptedData
,
iv
})
})
```
```
...
@@ -926,8 +965,9 @@ await uniIdCo.bindMobileByMpWeixin({
...
@@ -926,8 +965,9 @@ await uniIdCo.bindMobileByMpWeixin({
|参数名 |类型 |必填 |说明 |
|参数名 |类型 |必填 |说明 |
|-- |-- |-- |-- |
|-- |-- |-- |-- |
|encryptedData |string |是 |微信小程序获取手机号返回的encryptedData参数|
|encryptedData |string |是 |微信小程序获取手机号返回的encryptedData参数 |
|iv |string |是 |微信小程序获取手机号返回的iv参数 |
|iv |string |是 |微信小程序获取手机号返回的iv参数 |
|code |string |是 |微信小程序获取手机号返回的code参数;
`uni-id-co >= 1.0.25支持`
|
**返回值**
**返回值**
...
@@ -1065,6 +1105,52 @@ await uniIdCo.bindApple({
...
@@ -1065,6 +1105,52 @@ await uniIdCo.bindApple({
-
仅在用户token即将过期时返回新newToken
-
仅在用户token即将过期时返回新newToken
### 解绑第三方账号@unbind-third-account <Badge text="uni-id-co 1.0.25+" />
> 如账号只有一个第三方登录方式时,需绑定手机号后在解绑。
#### 解绑微信@unbind-weixin
**接口形式**
```
js
await
uniIdCo
.
unbindWeixin
()
```
**返回值**
|参数名 |类型 |说明 |
|-- |-- |-- |
|errCode |string
|
number |错误码 |
|errMsg |string |错误信息 |
#### 解绑QQ@unbind-qq
**接口形式**
```
js
await
uniIdCo
.
unbindQQ
()
```
**返回值**
|参数名 |类型 |说明 |
|-- |-- |-- |
|errCode |string
|
number |错误码 |
|errMsg |string |错误信息 |
#### 解绑支付宝@unbind-alipay
**接口形式**
```
js
await
uniIdCo
.
unbindAlipay
()
```
**返回值**
|参数名 |类型 |说明 |
|-- |-- |-- |
|errCode |string
|
number |错误码 |
|errMsg |string |错误信息 |
#### 解绑苹果账号@unbind-apple
**接口形式**
```
js
await
uniIdCo
.
unbindApple
()
```
**返回值**
|参数名 |类型 |说明 |
|-- |-- |-- |
|errCode |string
|
number |错误码 |
|errMsg |string |错误信息 |
### 用户信息@user-info
### 用户信息@user-info
#### 修改密码@update-pwd
#### 修改密码@update-pwd
...
@@ -1126,7 +1212,7 @@ await uniIdCo.resetPwdBySms({
...
@@ -1126,7 +1212,7 @@ await uniIdCo.resetPwdBySms({
|参数名 |类型 |说明 |
|参数名 |类型 |说明 |
|-- |-- |-- |
|-- |-- |-- |
|errCode |string
|
number |错误码 |
|errCode |string
|
number |错误码 |
|errMsg |string |错误信息 |
|errMsg |string |错误信息 |
#### 通过邮箱验证码重置密码@reset-pwd-by-email
#### 通过邮箱验证码重置密码@reset-pwd-by-email
...
@@ -1327,8 +1413,8 @@ await uniIdCo.sendSmsCode({
...
@@ -1327,8 +1413,8 @@ await uniIdCo.sendSmsCode({
|参数名 |类型 |说明 |
|参数名 |类型 |说明 |
|-- |-- |-- |
|-- |-- |-- |
|errCode |string
|
number |错误码 |
|errCode |string
|
number |错误码 |
|errMsg |string |错误信息 |
|errMsg |string |错误信息 |
#### 发送邮箱验证码@send-email-code
#### 发送邮箱验证码@send-email-code
**接口形式**
**接口形式**
...
@@ -1433,7 +1519,7 @@ await uniIdCo.addUser({
...
@@ -1433,7 +1519,7 @@ await uniIdCo.addUser({
|password |string |是 |密码 |
|password |string |是 |密码 |
|authorizedApp|Array
<
string
>
|否 |允许登录的app列表 |
|authorizedApp|Array
<
string
>
|否 |允许登录的app列表 |
|nickname |string |否 |昵称 |
|nickname |string |否 |昵称 |
|role |Array
<
string
>
|否 |用户角色 |
|role |Array
<
string
>
|否 |用户角色 |
|mobile |string |否 |手机号 |
|mobile |string |否 |手机号 |
|email |string |否 |邮箱 |
|email |string |否 |邮箱 |
|tags |array |否 |用户标签 |
|tags |array |否 |用户标签 |
...
@@ -1757,4 +1843,4 @@ exports.main = async (event, context) => {
...
@@ -1757,4 +1843,4 @@ exports.main = async (event, context) => {
return
{}
return
{}
};
};
```
```
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录