获取所有用户组

  • 接口说明： 获取所有用户组
  • 接口地址： /api/groups
  • 请求方式： GET

请求参数

参数名称类型是否必须描述
includestring否关联数据
filter[isDefault]string否是否只返回默认用户组
filter[type]string否传 invite 返回当前用户可见用户组（非管理员不返回游客、管理员用户组），前端用户组管理也可以使用次参数控制非管理员的展示内容

include 可关联的数据

关联名称模型类型是否默认描述
permissionpermissionobject是权限

请求示例

/api/groups?filter[type]=invite

返回说明

  • 返回当前创建成功数据， http 状态码： 200

返回结果

返回示例

  1. {
  2.   "data": [
  3.     {
  4.       "type": "groups",
  5.       "id": "1",
  6.       "attributes": {
  7.         "name": "管理员",
  8.         "type": "",
  9.         "color": "",
  10.         "icon": "",
  11.         "default": false,
  12.         "isDisplay": false
  13.       }
  14.     },
  15.     {
  16.       "type": "groups",
  17.       "id": "7",
  18.       "attributes": {
  19.         "name": "游客",
  20.         "type": "",
  21.         "color": "",
  22.         "icon": "",
  23.         "default": false,
  24.         "isDisplay": false
  25.       }
  26.     },
  27.     {
  28.       "type": "groups",
  29.       "id": "10",
  30.       "attributes": {
  31.         "name": "普通会员",
  32.         "type": "",
  33.         "color": "",
  34.         "icon": "",
  35.         "default": true,
  36.         "isDisplay": false
  37.       }
  38.     }
  39.   ]
  40. }