uni.login(options)
登录
Android、iOS还未提供此功能,请在插件市场搜索替代方案。详情
login 兼容性
| Web | 微信小程序 | Android | iOS | HarmonyOS |
| x | 4.41 | x | x | 4.61 |
参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
| options | LoginOptions | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | provider | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | x | x | x | 4.61 |
| 授权登录服务提供商,通过uni.getProvider获取,如果不设置则弹出分享列表选择界面
| | 合法值 | 兼容性 | 描述 | | weixin | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | 4.81 |
| 微信登录 | | qq | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| QQ登录 | | sinaweibo | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| 新浪微博登录 | | xiaomi | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| 小米登录 | | apple | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| Apple登录 | | huawei | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | 4.61 |
| 华为 HarmonyOS 华为账号登录 |
| | scopes | any | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| 授权类型,默认 auth_base。支持 auth_base(静默授权)/ auth_user(主动授权) / auth_zhima(芝麻信用)
| | timeout | number | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 2.35 | x | x | x |
| 超时时间,单位 ms | | onlyAuthorize | boolean | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | 4.81 |
| 微信登录仅请求授权认证
| | success | (result: LoginSuccess) => void | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 接口调用成功的回调函数 | | fail | (result: LoginFail) => void | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 接口调用失败的回调函数 | | complete | (result: any) => void | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 接口调用结束的回调函数(调用成功、失败都会执行) |
|
LoginSuccess 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 描述信息 |
| authResult | any | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | 4.61 |
| 登录服务商提供的登录信息,服务商不同返回的结果不完全相同 |
| code | string | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | 4.61 |
| 小程序用户临时登录凭证 |
| anonymousCode | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| 头条小程序当前设备标识 |
| authCode | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| 支付宝小程序授权码 |
| authErrorScope | any | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| 支付宝小程序登录失败的授权类型,key是授权失败的 scope,value 是对应的错误码 |
| authSucessScope | Array<string> | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| 支付宝小程序登录成功的授权 scope |
| appleInfo | AppleLoginAppleInfo | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| 苹果登录成功返回的信息 |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | authorizationCode | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 应用程序用来与服务器交互的令牌 | | fullName | any | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 返回身份的全名 | | identityToken | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 一个JSON Web令牌(JWT),可以安全地将用户信息传递给应用程序 | | realUserStatus | number | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 指示用户是否为真人 | | user | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 验证用户的标识符 |
|
LoginFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errCode | number | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 微信登录错误码 |
| 合法值 | 兼容性 | 描述 | | 1310500 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 未找到微信 APPID | | 1310501 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| APPID、appIdentifier、bundleId不匹配 | | 1310502 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 微信可能未安装 | | 1310503 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 未获取到授权凭证 | | 1310504 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 未获取到授权 code | | 1310505 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 授权凭证无效 | | 1310506 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 获取用户信息失败 | | 1310507 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 微信 API 请求失败 | | 1310508 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 微信登录state验证失败 | | 1310509 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 用户取消登录 | | 1310510 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 超时时间必须为正整数 | | 1310511 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 获取用户信息请求超时 | | 1001502040 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 登录请求可能被跨站攻击 |
|
| errno | number | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 需要基础库: 2.24.0
errno 错误码,错误码的详细说明参考 Errno错误码
|
| errSubject | string | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 统一错误主题(模块)名称 |
| data | any | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 错误信息中包含的数据 |
| cause | Error | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 源错误信息,可以包含多个错误,详见SourceError |
| errMsg | string | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| |
参见
uni.getUserInfo(options)
获取用户信息
getUserInfo 兼容性
| Web | 微信小程序 | Android | iOS | HarmonyOS |
| x | 4.41 | x | x | 4.61 |
参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
| options | GetUserInfoOptions | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | provider | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | x | x | x | 4.61 |
| 授权登录服务提供商,通过uni.getProvider获取 | | 合法值 | 兼容性 | 描述 | | weixin | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| 微信登录。 - 推荐: 使用 uniCloud 提供的云函数登录方式,避免在客户端暴露 appSecret。 1. 获取微信openid 2. 获取App平台微信登录用户信息 | | qq | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| QQ登录 | | sinaweibo | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| 新浪微博登录 | | xiaomi | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| 小米登录 | | apple | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | x |
| Apple登录 | | huawei | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | 4.61 |
| 华为 HarmonyOS 华为账号登录 |
| | withCredentials | boolean | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | x |
| 是否带上登录态信息,仅微信小程序生效。 | | lang | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | x |
| 指定返回用户信息的语言,zh_CN 简体中文,zh_TW 繁体中文,en 英文。默认为en,仅微信小程序生效。 | | timeout | number | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | x |
| 超时时间,单位 ms | | success | (result: GetUserInfoSuccess) => void | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 接口调用成功的回调函数 | | fail | (result: GetUserInfoFail) => void | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 接口调用失败的回调函数 | | complete | (result: any) => void | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 接口调用结束的回调函数(调用成功、失败都会执行) |
|
GetUserInfoSuccess 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| userInfo | UserInfo | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | 4.61 |
| 用户信息对象,不包含 openid 等敏感信息 |
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | | nickName | string | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 用户昵称 | | openId | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | x | x | x | 4.61 |
| 该服务商唯一用户标识 | | avatarUrl | string | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 用户头像 | | gender | number | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | x | x | x | 4.81 |
| 用户性别(仅微信登录支持) | | 合法值 | 兼容性 | 描述 | | 0 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 男 | | 1 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 女 | | 2 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 保密 | | 0 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| - | | 1 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| - | | 2 | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| - |
| | city | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| | | country | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| | | language | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 可选值: - 'en': 英文; - 'zh_CN': 简体中文; - 'zh_TW': 繁体中文;
| | 合法值 | 兼容性 | 描述 | | en | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| - | | zh_CN | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| - | | zh_TW | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| - |
| | province | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| |
|
| rawData | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | x |
| 不包括敏感信息的原始数据字符串,用于计算签名。 |
| signature | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | x |
| 使用 sha1( rawData + sessionkey ) 得到字符串,用于校验用户信息,仅微信小程序生效。 |
| encryptedData | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | x |
| 包括敏感数据在内的完整用户信息的加密数据,详细见加密数据解密算法,仅微信小程序生效。 |
| iv | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | x |
| 加密算法的初始向量,详细见加密数据解密算法,仅微信小程序生效。 |
| errMsg | string | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 描述信息 |
| cloudID | string | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | 4.41 | x | x | - |
| 需要基础库: 2.7.0
敏感数据对应的云 ID,开通云开发的小程序才会返回,可通过云调用直接获取开放数据,详细见云调用直接获取开放数据
|
GetUserInfoFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errCode | number | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 统一错误码 |
| errSubject | string | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 统一错误主题(模块)名称 |
| data | any | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 错误信息中包含的数据 |
| cause | Error | 否 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| 源错误信息,可以包含多个错误,详见SourceError |
| errMsg | string | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | x | - | x | x | - |
| |
参见
通用类型
GeneralCallbackResult
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
| errMsg | string | 是 | - | |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| | - | 4.41 | - | - | - |
| 错误信息 |