---
url: /api-proxy/open-api/user-info/getUserInfo.md
---
## mpx.getUserInfo(Object object)

获取用户信息。

支持情况： 微信、支付宝

[参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/user-info/wx.getUserInfo.html)

### 参数 {#parameters}

**Object object**

**object.success 回调函数**

**参数**

**Object res**

属性	类型	说明	最低版本
| 属性         | 类型     | 说明                                                                 | 最低版本 |
|--------------|----------|----------------------------------------------------------------------|----------|
| userInfo     | UserInfo | 用户信息对象，不包含 openid 等敏感信息                               |          |
| rawData      | string   | 不包括敏感信息的原始数据字符串，用于计算签名                         |          |
| signature    | string   | 使用 sha1( rawData + sessionkey ) 得到字符串，用于校验用户信息，详见 用户数据的签名验证和加解密 |          |
| encryptedData| string   | 包括敏感数据在内的完整用户信息的加密数据，详见 用户数据的签名验证和加解密 |          |
| iv           | string   | 加密算法的初始向量，详见 用户数据的签名验证和加解密                   |          |
| cloudID      | string   | 敏感数据对应的云 ID，开通云开发的小程序才会返回，可通过云调用直接获取开放数据，详细见云调用直接获取开放数据 | 2.7.0    |

### 示例代码 {#example-code}

```js
mpx.getUserInfo({
  success: function(res) {
    var userInfo = res.userInfo
    var nickName = userInfo.nickName
    var avatarUrl = userInfo.avatarUrl
    var gender = userInfo.gender //性别 0：未知、1：男、2：女
    var province = userInfo.province
    var city = userInfo.city
    var country = userInfo.country
  }
})
```
