---
order: 4
navTitle: 获取用户信息
---
# 获取用户信息

用于第三方应用获取指定用户的信息。

调用此API时第三方应用必须已经用于合法的`access_token`。

## 调用说明

请求方式： `POST`\
请求url：`/api/oauth2/getUserInfo`\
请求参数示例：

```json
{
    "access_token": "5rc6t7vyb8u9nimpo"
}
```

参数说明：

| 参数         | 必须 | 说明                                                                                                                                                                                                                       |
| :----------- | :--- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| access\_token | 是   | 调用接口凭证，[静默授权应用](../../../../sys-settings/security/trustedapps.md#静默授权应用)和[开放授权信应用](../../../../sys-settings/security/trustedapps.md#开放授权应用)根据[换取access\_token](./getToken.md)API获取 |

## 返回值说明

示例：

```json
{
    "errorCode": "tokenInvalid",
    "message": "access_token 无效",
    "user":{
        "userId": "342112",
        "userName": "张三",
        "phone": "13112345678",
        "email": "xxx@email.com",
        "deptId" : "development",
        "avatar": "http://example.com/api/avatar/xxx",
    }
}
```

参数说明：

| 参数          | 说明         |
| :------------ | :----------- |
| errorCode     | 错误码       |
| message       | 错误文本提示 |
| user.userId   | 用户ID       |
| user.userName | 姓名     |
| user.phone    | 手机号       |
| user.email    | 邮件地址     |
| user.deptId   | 所在部门的ID |
| user.avatar   | 头像地址     |

`errorCode`说明：
| errorCode     | 说明        |
| :------------ | :---------- |
| tokenNotFound | token不存在 |
| tokenExpired  | token过期了 |

::: tip 提示
可引用的用户属性包括系统[用户表](../../../sys-tables/README.md#users)和[外部用户表](../../../sys-tables/README.md#external-users)中所有的非私有属性，引用时将用户表中物理字段名从下划线命名变为驼峰式命名，例如：用户表`姓名`字段的物理字段名是`USER_NAME`，则使用`user.userName`引用
:::