账户角色管理接口文档
chenhongzhou редактира тази страница преди 4 години

1. 账户管理-根据条件查询账户,无条件则查所有

  • • url: /ums/account/ queryAccounts
  • • 协议:http
  • • 请求方法: post
  • • 请求参数格式:"application/json"
  • • 字符集:UTF-8
  • • 请求参数
  • • 格式:json

{

"pageIndex": 页码,
"pageSize": 行数,
"filters": [
    {
        "field": "nickName",
        "operate": "contains",
        "value": "搜索词"
    }

],

"sortDirection": 1倒序或0正序,
"sortField": "排序字段"

}

  • • 返回参数
  • • 格式:json

{

"success": 1,
"messageCode": 200,
"message": "操作成功",
"result": "查询所有角色成功",
"items": [
    {
        "id": "账户ID",
        "loginId": "账户登录名",
        "nickName": "账户昵称",
        "password": "账户密码",
        "accountCode": "10004",
        "encrypteType": null,
        "recordState": 记录状态(0:注销,2:激活 -4:删除),
        "creationDate": "创建时间",
        "createByUser": ”创建者ID,
        "lastModified": "最后修改时间",
        "updateByUser": ,
        "secret": null,
        "status": 账户状态(0:禁用 1:启用 -3:垃圾桶 -4:删除),
        "password1": null,
        "roleKey": "角色英文名",
        "deptCode": null,
        "orgKey": null,
        "extra": null,
        "roleList": [
            {
                "id": "角色ID",
                "creationDate": "创建时间",
                "lastModified": "最后修改时间",
                "roleName": "角色名",
                "organizationCode": "",
                "createByUser": "",
                "lastModifiedUser": "最后修改者ID",
                "remark": "",
                "appId": 应用ID,
                "applicationKey": "test",
                "roleKey": "角色英文名",
                "status": 角色状态(0:禁用 1:启用 -4:删除),
                "resourceList": null,
                "recordState": 记录状态(0:注销,2:激活 -4:删除)
            }
        ],
        "createDate": "创建时间",
        "lockBuyUser": 是否锁定
    },

}

2. 账户管理-添加账户

  • • url: /ums/account/ addAccount
  • • 协议:http
  • • 请求方法: post
  • • 请求参数格式:"application/json"
  • • 字符集:UTF-8
  • • 请求参数
  • • 格式:json

{

"loginId": "账户登录名",
"nickName": "账户昵称",
"password": "账户密码",
"phoneNumber":"手机号码",
"roleList":[
    {
        "id":"角色ID"
    }
]

}

  • • 返回参数
  • • 格式:json

{

"success": 1,
"messageCode": 200,
"message": "操作成功!",
"result": "创建用户成功",
"items": null,
"totalCount": 0

}

3. 账户管理-更新账户

  • • url: /ums/account/ editAccount
  • • 协议:http
  • • 请求方法: post
  • • 请求参数格式:"application/json"
  • • 字符集:UTF-8
  • • 请求参数
  • • 格式:json

{

"id":"账户ID",
"loginId": "账户登录名",
"nickName": "账户昵称",
"password": "账户密码",
"phoneNumber":"手机号码",
"roleList":[
    {
        "id":"角色ID"
    }
]

}

  • • 返回参数
  • • 格式:json

{

"success": 1,
"messageCode": 200,
"message": "操作成功!",
"result": "更新角色成功",
"items": null,
"totalCount": 0

}

4. 账户管理-冻结/激活账户

  • • url: /ums/account/ editAccount
  • • 协议:http
  • • 请求方法: post
  • • 请求参数格式:"application/json"
  • • 字符集:UTF-8
  • • 请求参数
  • • 格式:json

{

"id":"账户ID",
"recordState": 0 (0:禁用 2:启用)

}

  • • 返回参数
  • • 格式:json

{

"success": 1,
"messageCode": 200,
"message": "操作成功!",
"result": "更新角色成功",
"items": null,
"totalCount": 0

}

5. 账户管理-删除账户

  • • url: /ums/account/ deleteAccount
  • • 协议:http
  • • 请求方法: post
  • • 请求参数格式:"application/json"
  • • 字符集:UTF-8
  • • 请求参数
  • • 格式:json

{

"id":"账户ID"

}

  • • 返回参数
  • • 格式:json

{

"success": 1,
"messageCode": 200,
"message": "操作成功!",
"result": "删除角色成功",
"items": null,
"totalCount": 0

}

6. 角色管理-根据条件查询角色,无条件则查所有

  • • url: /ums/role/ queryRoles
  • • 协议:http
  • • 请求方法: post
  • • 请求参数格式:"application/json"
  • • 字符集:UTF-8
  • • 请求参数
  • • 格式:json

{

"pageIndex": 页码,
"pageSize":行数,
"filters":[
    {
        "field": "roleName",
        "operate": "contains",
        "value": "搜索词"
    }

],

"sortDirection": 1倒序或0正序,
"sortField": "排序字段"

}

  • • 返回参数
  • • 格式:json

{

"success": 1,
"messageCode": 200,
"message": "操作成功",
"result": "查询所有角色成功",
"items": [
    {
        "id": "角色ID",
        "creationDate": "创建时间",
        "lastModified": "最后修改时间",
        "roleName": "角色名称",
        "organizationCode": "",
        "createByUser": "",
        "lastModifiedUser": "最后修改者ID",
        "remark": "",
        "appId": 应用ID,
        "applicationKey": null,
        "roleKey": null,
        "status": 角色状态(0:禁用 1:启用 -4:删除),
        "resourceList": null,
        "recordState": 记录状态(0:注销,2:激活 -4:删除)
    }
],
"totalCount": 总数

}

7. 角色管理-根据角色ID查询角色详情

  • • url: /ums/role/ queryRoleByRoleId/{ roleId}
  • • 协议:http
  • • 请求方法: get
  • • 请求参数格式:"application/json"
  • • 字符集:UTF-8
  • • 请求参数(无)
  • • 返回参数
  • • 格式:json

{

"success": 1,
"messageCode": 200,
"message": "操作成功",
"result": "查询角色详情成功",
"items": {
    "id": "角色ID",
    "creationDate": "创建时间",
    "lastModified": "最后修改时间",
    "roleName": "角色名称",
    "organizationCode": "",
    "createByUser": "",
    "lastModifiedUser": "最后修改者ID",
    "remark": "",
    "appId": 应用ID,
    "applicationKey": null,
    "roleKey": null,
    "status": 1,
    "resourceList": [
        {
            "resId": 权限资源ID,
            "id": "权限ID",
            "parentId": 父权限ID,
            "appId": 应用ID,
            "resourceTypeId": 资源类型ID,
            "code": "1000001",
            "description": "权限描述",
            "types": 类型,
            "icon": 图标,
            "status": 状态,
            "createTime": "创建时间",
            "createUserId": 创建者ID,
            "updateTime": "最后修改时间",
            "updateUserId": 最后修改者ID,
            "parentResourceUid": null,
            "roleIds": null,
            "parentResId": 父级权限资源ID,
            "orderNum": null,
            "pageName": null,
            "actionType": null,
            "isVisible": null,
            "appName": null,
            "menuName": "权限名称",
            "linkUrl": "链接"
        }

    ],
    "recordState": 2
},
"totalCount": 1

}

8. 角色管理-新增角色

  • • url: /ums/role/ addOrEditRole
  • • 协议:http
  • • 请求方法: post
  • • 请求参数格式:"application/json"
  • • 字符集:UTF-8
  • • 请求参数
  • • 格式:json

{

        "roleName": "角色名",
        "remark": "角色描述",
        "resourceList":[
            {"id": "权限ID"}
        ]

}

  • • 返回参数
  • • 格式:json

{

"success": 1,
"messageCode": 200,
"message": "操作成功!",
"result": "创建角色成功",
"items": null,
"totalCount": 0

}

9. 角色管理-编辑角色

  • • url: /ums/role addOrEditRole
  • • 协议:http
  • • 请求方法: post
  • • 请求参数格式:"application/json"
  • • 字符集:UTF-8
  • • 请求参数
  • • 格式:json

{

        "id":"角色ID",
        "roleName": "角色名",
        "remark": "角色描述",
        "resourceList":[
            {"id": "权限ID"}
        ]

}

  • • 返回参数
  • • 格式:json

{

"success": 1,
"messageCode": 200,
"message": "操作成功!",
"result": "创建角色成功",
"items": null,
"totalCount": 0

}

10. 角色管理-删除角色

  • • url: /ums/role/deleteRole
  • • 协议:http
  • • 请求方法: post
  • • 请求参数格式:"application/json"
  • • 字符集:UTF-8
  • • 请求参数
  • • 格式:json

{

"id": "角色ID"

}

  • • 返回参数
  • • 格式:json

{

"success": 1,
"messageCode": 200,
"message": "操作成功!",
"result": "删除角色成功",
"items": null,
"totalCount": 0

}

11. 角色管理-权限列表

  • • url: /ums/role/ menuTree
  • • 协议:http
  • • 请求方法: post
  • • 请求参数格式:"application/json"
  • • 字符集:UTF-8
  • • 请求参数
  • • 格式:json(无)
  • • 返回参数
  • • 格式:json

{

"success": 1,
"messageCode": 200,
"message": "操作成功",
"result": "查询树状资源成功",
"items": [
    {
        "parentId": 父级资源ID,
        "id": 资源ID,
        "value": "权限ID",
        "label": "权限名称",
        "childNode": [
            {
                 "parentId": 父级资源ID,
                  "id": 资源ID,
                  "value": "权限ID",
                  "label": "权限名称",
                "childNode": null
            }
        ]
    }
]