提交 d54cb2b3 编写于 作者: DCloud_Heavensoft's avatar DCloud_Heavensoft 提交者: Gitee

update docs/uniCloud/uni-id.md.

上级 ad6feca6
......@@ -26,11 +26,11 @@
提供一个名为`uni-id`的公共模块,该模块封装了一系列API,包括注册、登录、修改密码、设置头像等。
示例工程中还提供了一个`user-center`的云函数,演示在云函数中如何调用`uni-id`公共模块。
示例工程中还提供了一个`user-center`的云函数,演示在云函数中如何调用`uni-id`公共模块。推荐使用[云端一体登录插件](https://ext.dcloud.net.cn/plugin?id=13)
3.前端调用
前端示例通过callfunction调用云函数`user-center`,在注册和登录时保存token。
前端示例通过callfunction调用云函数`user-center`,在注册和登录时保存token。在这个[云端一体登录插件](https://ext.dcloud.net.cn/plugin?id=13)里,有完整的登录、注册、修改密码等前后端代码示例。[详见](https://ext.dcloud.net.cn/plugin?id=13)
uniCloud框架底层,会自动在callfunction时传递`uni-id`的token(uni-app 2.7.13+版本)。在云函数的event中可直接拿到`uni-id`的token。也就是说开发者无需自己管理token了。
......@@ -71,7 +71,7 @@ DCloud暂无计划开发百度、头条、QQ等小程序的登录,以及微博
2.邮箱验证集成
邮箱验证,DCloud暂无计划开发,有需求的开发者欢迎提供pr。
发送邮件验证邮箱真实性,DCloud暂无计划开发,有需求的开发者欢迎提供pr。
3.活体检测
......@@ -372,6 +372,8 @@ function hasPermission(token, permission) {
}
```
注意:**在uniCloud admin中,封装了可视化的用户、权限、角色的管理,新增删除修改均支持。**无需自己维护。[详见](https://uniapp.dcloud.net.cn/uniCloud/admin?id=mutiladmin)
# uni-id的API列表@api
`uni-id`作为一个云函数的公共模块,暴露了各种API,供云函数调用。
......@@ -391,7 +393,7 @@ CreateInstanceParams内可以传入云函数context
const uniID = require('uni-id')
exports.main = async function(event,context) {
const uniIDIns = uniID.createInstance({ // 创建uni-id实例,其上方法同uniID
context: context,
context: context,
config: {} // 完整uni-id配置信息,使用config.json进行配置时无需传此参数
})
payload = await uniIDIns.checkToken(event.uniIdToken) // 后续使用uniIDIns调用相关接口
......@@ -524,10 +526,10 @@ uniCloud.callFunction({
| needPermission| Boolean | 否 |设置为true时会在checkToken时返回用户权限(permission)。`uni-id 3.0.0`起,如果配置`"removePermissionAndRoleFromToken": false`此选项不再生效 |
| queryField | Array| 否 |指定从哪些字段中比对username(传入参数均为username),不填默认与数据库内的username字段对比, 可取值'username'、'email'、'mobile'|
> 如果希望使用queryField来允许用户同时使用多种方式登录,需要注意必须限制用户注册用户名不为邮箱格式且不为手机号格式,uni-id内部并未做出此类限制
**注意**
> 如果希望使用queryField来允许用户同时使用多种方式登录,需要注意必须限制用户注册用户名不为邮箱格式且不为手机号格式,uni-id内部并未做出此类限制
**注意**
- 使用邮箱时需要用户对应的记录里`email_confirmed`为1才可以登录,手机号同样需要`mobile_confirmed`为1才可以登录
**响应参数**
......@@ -1287,12 +1289,12 @@ exports.main = async function(event,context) {
| --- | --- | --- | --- |
| uid | String| 是 |用户Id,可以通过checkToken返回 |
| mobile | String| 否 |用户手机号 |
| code | String| 否 |验证码,为兼容旧版逻辑此参数不填写时不会进行验证码校验,而是直接绑定手机号 |
| code | String| 否 |验证码,为兼容旧版逻辑此参数不填写时不会进行验证码校验,而是直接绑定手机号 |
| access_token| String| 否 |uni.login登录成功后,返回的`access_token`参数 |
| openid | String| 否 |uni.login登录成功后,返回的`openid`参数 |
| type | String| 否 |通过何种方式绑定手机号,sms(手机号验证码)、univerify(一键登录),默认sms|
type为sms时mobile、code必传,type为univerify时access_token、openid必传
type为sms时mobile、code必传,type为univerify时access_token、openid必传
**响应参数**
......@@ -1523,12 +1525,12 @@ exports.main = async function(event,context) {
- uniId会自动判断客户端平台
- 登录成功之后应持久化存储token、token过期时间,键值为:`uni_id_token、uni_id_token_expired`,例:`uni.setStorageSync('uni_id_token', res.result.token)`
- App端获取code不可直接调用`uni.login`,详细用法可以看下面示例
**APP微信登录详细配置流程**
1. 在manifest.json内配置微信登录用appid
2. **打包****使用**自定义基座(注意一定要在manifest.json填写微信appid后再制作自定义基座),[自定义基座使用说明](https://ask.dcloud.net.cn/article/35115)
3. 在uni-id的config.json内app-plus对应的微信登录信息内配置appid和appsecret
**APP微信登录详细配置流程**
1. 在manifest.json内配置微信登录用appid
2. **打包****使用**自定义基座(注意一定要在manifest.json填写微信appid后再制作自定义基座),[自定义基座使用说明](https://ask.dcloud.net.cn/article/35115)
3. 在uni-id的config.json内app-plus对应的微信登录信息内配置appid和appsecret
**参数说明**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册