Skip to content
On this page

User Roles

  • Endpoint Path: /api/v2/global/roles
  • Method: GET
  • Request: Query

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)
X-Fresns-Aidoptionalrequired
X-Fresns-Aid-Tokenoptionalrequired
X-Fresns-Uidoptionalrequired
X-Fresns-Uid-Tokenoptionalrequired

Query Params

Parameter NameTypeRequiredDescription
idsStringoptional角色 rid,多个以英文逗号隔开
typeNumberoptional1 管理人员类
2 系统设置类
3 用户运营类
留空输出全部
statusBooleanoptional0 停用角色
1 启用角色
留空输出全部
pageSizeNumberoptional每页显示条数(默认 15 条)
pageNumberoptional页码(默认 1)

Return

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / How much data in total",
            "pageSize": "Number / How much data on each page",
            "currentPage": "Number / Current page number",
            "lastPage": "Number / Last page number"
        },
        "list": [
            {
                "rid": "Number / 角色 ID",
                "nicknameColor": "String / 角色用户的昵称颜色",
                "name": "String / 角色名称",
                "nameDisplay": "Boolean / 是否显示角色名",
                "icon": "String / 角色图标 URL",
                "iconDisplay": "Boolean / 是否显示角色图标",
                "permission": [
                    // roles 表 permission 字段所有内容
                ],
                "status": "Boolean / 启用状态",
            }
        ]
    }
}

Released under the Apache-2.0 License