# PingCAP Account API 文档

## 说明

> 所有的 API 调用都有频率限制，未认证用户 30 次/分钟, 认证用户 100 次/分钟，超出调用频率会返回 HTTP-Status-Code 429  
> i18n支持(zh-hans/en-us), 在请求 Header 中声明： Accept-Language: zh-hans
> 以下 API 文档中均未提及 5xx 错误, 但你在使用 API 的时候应考虑到相关错误(包括网络延时)  

- [获取用户列表]](#获取用户列表)

### 获取用户列表

#### Request

- Method: **GET**
- URL: `/api/admin/users`
- Content-Type: application/json
- Params:
  | 参数名 | 类型 | 默认值| 是否必填 | 说明 |
  | ---- | ---- | ---- | ---- | ----- |
  | currentPage | int | 1 | 否 | 当前页数 |
  | perPage | int | 10 | 否 | 每页多少条数据 |
  | search | string | 无 | 否 | 搜索关键词 |
- Permission: Admin:pingcap_sso.view_user_list

#### Response Example

- Success

  - HTTP/1.1 200

  ```json
  {
    "detail": "成功",
    "data": [
        {
            "id": 1,   // 用户在 Account 中的唯一标识
            "openid": "5cd090de-10d5-11ea-85b7-1866da9ce92b",  // 用户在社区的唯一标识
            "username": "username",
            "phone": null,
            "email": "test@email.com",
            "name": "姓名",
            "company_name": "平凯星辰（北京）科技有限公司",
            "last_login": "2021/11/22 11:56",
            "point_stat": {
                "points": 320,   // 积分
                "experience": 800,  // 经验
                "level": 5   // 等级
            },
            "org": {
                "name": "组织名称",
                "slug": "2215bae44cbd4f5e9fa7e4c8d2338a23"
            }
        }
    ],
    "total_num": 1,
    "per_page": 20,
    "cur_page": 1,
    "order_by": "-date_joined"
  }
  ```