# 角色组角色

# 定义

# 组织用户

OrgUser

主键 类型 id 描述
主键 String id
编码 String code
类型 int type
名称 String name
父节点ID String parentId
全路径 String treePath
中文全路径 String namePath
维度ID String dimId
排序 int orderNum
全名 String fullName
组织层级 int levelType
二级集团单位标识 String providerId
虚拟组织机构标志 int virtually
性别 int gender
负责人标志 int leader
主岗位标志 int mainPosition
子列表 List <OrgUser> children
账号 String account

# 角色角色组

Group

名称 类型 字段 描述
主键 String id
编码 String code
类型 int type 0:角色组 1:角色
父节点ID String parentId
全路径 String treePath
所属应用ID String systemId
中文全路径 String namePath
子列表 List <Group> children

# 接口

# 按照系统获取角色组根节点

按应用查询角色组根节点,应用通过clientid转换

  • 请求路径

    /groups/root

  • 请求方法

    GET

  • 接口参数

    名称 类型 字段名 描述
    组织维度 String orgDim 为空时获取所有
    组织主键 String orgId 预留字段,非必填
  • 返回信息

    名称 类型 字段名 描述
    组织信息 List <Group> gourps

# 按照ID获取对应角色或角色组信息

  • 请求路径

    /groups/{groupId}

  • 请求方法

    GET

  • 接口参数

    名称 类型 字段名 描述
    角色(角色组)主键 String groupId
  • 返回信息

    名称 类型 字段名 描述
    角色(角色组) Group gourp

# 按照ID获取对应角色(角色组)所有父节点信息

  • 请求路径

    /groups/{groupId}/parents

  • 请求方法

    GET

  • 接口参数

    名称 类型 字段名 描述
    角色(角色组)主键 String groupId
  • 返回信息

    名称 类型 字段名 描述
    角色(角色组)列表 List <Group> gourps

# 按照角色组ID获取角色组下级节点列表

  • 请求路径

    /groups/{groupId}/next

  • 请求方法

    GET

  • 接口参数

    名称 类型 字段名 描述
    角色(角色组)主键 String groupId
  • 返回信息

    名称 类型 字段名 描述
    角色(角色组)列表 List <Group> gourps

# 搜索角色组下角色(角色组)

搜索角色组或者角色

  • 请求路径

    /groups/search

  • 请求方法

    GET

  • 接口参数

    名称 类型 字段名 描述
    角色(角色组)名称 String name
    组织主键 String orgId 预留字段,非必填
    角色组主键 List <String> groupIds 非必填
  • 返回信息

    名称 类型 字段名 描述
    角色(角色组)列表 List <Group> gourps

# 搜索角色组下用户

  • 请求路径

    /groups/users/search

  • 请求方法

    GET

  • 接口参数

    名称 类型 字段名 描述
    用户名称 String name
    组织主键 String orgId 预留字段,非必填
    角色组主键 List<String> groupIds 非必填
  • 返回信息

    名称 类型 字段名 描述
    用户列表 List <OrgUser> orgUsers

# 获取所有角色、角色组树

  • 请求路径

    /groups/tree

  • 接口参数

    名称 类型 字段名 描述
    组织主键 String orgId 预留字段,非必填
    组织维度 String orgDim 预留字段,非必填
  • 返回信息

    名称 类型 字段名 描述
    角色(角色组)列表 List <Group> gourps

# 按照角色ID(角色组id)获取角色下所有用户

  • 请求路径

    /groups/{groupId}/users

  • 接口参数

    名称 类型 字段名 描述
    组织主键 String orgId 预留字段,非必填
    组织维度 String orgDim 预留字段,非必填
    角色组主键 String groupId 必填
  • 返回信息

    名称 类型 字段名 描述
    用户列表 List <OrgUser> orgUsers

# 按照用户ID获取用户所属角色列表

  • 请求路径

    /users/{userId}/groups

  • 接口参数

    名称 类型 字段名 描述
    用户主键 String userId 必填
    组织主键 String orgId 预留字段,非必填
    组织维度 String orgDim 预留字段,非必填
  • 返回信息

    名称 类型 字段名 描述
    角色(角色组)列表 List <Group> groups