ks.getUserInfo

更新时间：2024-09-29 21:58:36

基础库1.26.1开始支持,低版本需做兼容处理

开发者工具1.22.0开始支持

获取用户信息。调用前需要 用户授权 scope.userInfo。

getUserInfo(options: GetUserInfoOptions): Promise<AuthorizedUserInfoResult | UserInfoResult>

参数

参数	类型	必填
options	GetUserInfoOptions	是

GetUserInfoOptions

属性

属性	类型	默认值	必填	说明
withCredentials	boolean	false	否	是否带上登录态信息。 当 withCredentials 为 true 时，要求用户登录态有效，此时返回的用户信息会包含 encryptedData, iv 等敏感信息。 当 withCredentials 为 false 时，返回的用户信息不包含敏感信息。
success	(result: AuthorizedUserInfoResult | UserInfoResult) => void		否	接口调用成功的回调函数
fail	(error: APIError) => void		否	接口调用失败的回调函数
complete	(resultOrError: AuthorizedUserInfoResult | UserInfoResult | APIError) => void		否	接口调用结束的回调函数（调用成功、失败都会执行）

返回值

Promise<AuthorizedUserInfoResult | UserInfoResult>

敏感数据解密后结构示例

{
    "gender": "gender", // 性别 0：未知、1：男、2：女
    "avatarUrl": "AVATARURL",
    "nickName": "NICKNAME",
    "openId": "OPENID",
}

AuthorizedUserInfoResult

属性

属性	类型	说明
rawData	string	不包括敏感数据的原始数据字符串，用于计算签名
signature	string	使用 sha1(rawData + session_key) 得到的字符串，用于校验用户信息数据合法性
encryptedData	string	包括敏感数据在内的完整用户信息的加密数据。详见 用户数据的签名验证和加解密
iv	string	加密算法的初始向量。详见 用户数据的签名验证和加解密
userInfo	UserInfo	用户信息

UserInfo

属性

属性	类型	说明
nickName	string	用户昵称
avatarUrl	string	用户头像图片的 URL

UserInfoResult

属性

属性	类型	说明
userInfo	UserInfo	用户信息

错误信息

错误信息	错误说明
auth deny	用户拒绝授权
Invalid app	应用不存在
beyond token/app/authorized scope	请求被拒绝，可能是无效token或应用/用户不允许访问该接口
not exist user	用户信息不存在
invalid scope	请求授权的scope错误

扫码体验

示例代码