角色组模块

一、角色组查看

接口地址 https://www.yingxiongyun.com/tenant/api/v1/t/roleGroups

请求方式 GET

consumes ["application/json"]

produces ["*/*"]

接口描述 ``

请求参数

暂无

响应状态

状态码	说明	schema
200	OK	响应结果对象«分页对象«分组名称»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	分页对象«分组名称»	分页对象«分组名称»
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

分页对象«分组名称»

参数名称	参数说明	类型	schema
body	分页数据	array	分组名称
pageNum	当前页数	integer(int32)
pageSize	每页条数	integer(int32)
total	总条数	integer(int64)

分组名称

参数名称	参数说明	类型
corpId	团队ID	string
createdAt	创建时间	string(date-time)
createdBy	创建人	string
deletedFlag	删除标识	boolean
id	唯一标识	string
lastModifiedAt	修改时间	string(date-time)
lastModifiedBy	最后修改人	string
name	角色组名称	string
position	顺序	integer(int32)

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "body": [
            {
                "corpId": "",
                "createdAt": "",
                "createdBy": "",
                "deletedFlag": false,
                "id": "",
                "lastModifiedAt": "",
                "lastModifiedBy": "",
                "name": "",
                "position": 0
            }
        ],
        "pageNum": 0,
        "pageSize": 0,
        "total": 0
    },
    "message": "",
    "timestamp": 0
}

二、角色组创建

接口地址 https://www.yingxiongyun.com/tenant/api/v1/t/roleGroups

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

接口描述 新增一条记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
body	body	body	true	角色组创建请求体	角色组创建请求体

schema属性说明

角色组创建请求体

参数名称	参数说明	请求类型	是否必须	数据类型	schema
name	角色组名称	body	false	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«角色组响应数据»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	角色组响应数据	角色组响应数据
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

角色组响应数据

参数名称	参数说明	类型	schema
enableManageFlag	可管理	boolean
id	主键ID	string
name	角色组名称	string
roleResponseList	角色	array	角色树响应数据

角色树响应数据

参数名称	参数说明	类型
description	角色描述	string
enableManageFlag	可管理	boolean
groupId	角色组主键id	string
id	主键ID	string
name	角色名称	string
status	角色状态 normal正常，deactivate停用	string

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "enableManageFlag": false,
        "id": "",
        "name": "",
        "roleResponseList": [
            {
                "description": "",
                "enableManageFlag": false,
                "groupId": "",
                "id": "",
                "name": "",
                "status": ""
            }
        ]
    },
    "message": "",
    "timestamp": 0
}

三、角色组修改

接口地址 https://www.yingxiongyun.com/tenant/api/v1/t/roleGroups/{groupId}

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

接口描述 修改一条记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
groupId	groupId	path	true	string
body	body	body	true	角色组修改请求体	角色组修改请求体

schema属性说明

角色组修改请求体

参数名称	参数说明	请求类型	是否必须	数据类型	schema
name	角色组名称	body	false	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«角色组响应数据»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	角色组响应数据	角色组响应数据
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

角色组响应数据

参数名称	参数说明	类型	schema
enableManageFlag	可管理	boolean
id	主键ID	string
name	角色组名称	string
roleResponseList	角色	array	角色树响应数据

角色树响应数据

参数名称	参数说明	类型
description	角色描述	string
enableManageFlag	可管理	boolean
groupId	角色组主键id	string
id	主键ID	string
name	角色名称	string
status	角色状态 normal正常，deactivate停用	string

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "enableManageFlag": false,
        "id": "",
        "name": "",
        "roleResponseList": [
            {
                "description": "",
                "enableManageFlag": false,
                "groupId": "",
                "id": "",
                "name": "",
                "status": ""
            }
        ]
    },
    "message": "",
    "timestamp": 0
}

四、删除角色组

接口地址 https://www.yingxiongyun.com/tenant/api/v1/t/roleGroups/{groupId}

请求方式 DELETE

consumes ["application/json"]

produces ["*/*"]

接口描述 删除一条记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
groupId	groupId	path	true	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«boolean»
204	No Content
401	Unauthorized
403	Forbidden

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	boolean
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": false,
    "message": "",
    "timestamp": 0
}