权限组

# 概述

权限组

类名

PermissionGroupApi.java

成员方法

名称	方法	Method	Path
添加权限组	addPermissionGroup	POST	/api-organization/permissiongroup/addPermissionGroup
授权权限组	authPermissionGroup	POST	/api-organization/permissiongroup/authPermissionGroup
授权项目	authProject	POST	/api-organization/permissiongroup/authProject
删除授权权限组	deleteAuthPermissionGroup	POST	/api-organization/permissiongroup/deleteAuthPermissionGroup
删除授权项目	deleteAuthProject	POST	/api-organization/permissiongroup/deleteAuthProject
删除权限组	deletePermissionGroup	POST	/api-organization/permissiongroup/deletePermissionGroup
获取用户的授权权限组	getAuthPermissionGroup	POST	/api-organization/permissiongroup/getAuthPermissionGroup
获取用户的授权项目	getAuthProject	POST	/api-organization/permissiongroup/getAuthProject
获取权限组列表	getPermissionGroupList	POST	/api-organization/permissiongroup/getPermissionGroupList
获取拥有的项目	getPermissionGroupProjectTree	POST	/api-organization/permissiongroup/getPermissionGroupProjectTree
修改权限组	updatePermissionGroup	POST	/api-organization/permissiongroup/updatePermissionGroup

# 添加权限组

ResultObject addPermissionGroup(name)

添加权限组

# 请求参数

名称	类型	描述	备注
name	String	权限组名称	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
PermissionGroupApi apiInstance = new PermissionGroupApi(token);
//实例化请求参数
String name = "name_example";

try {
    ResultObject result = apiInstance.addPermissionGroup(name);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用PermissionGroupApi.addPermissionGroup异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/permissiongroup/addPermissionGroup
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"name":""
}

1
2
3

# 授权权限组

ResultObject authPermissionGroup(addAuthForm)

授权权限组

# 请求参数

名称	类型	描述	备注
addAuthForm	AddAuthForm	addAuthForm

# AddAuthForm

名称	类型	描述
ids	List<String>	被授予的id(项目或者权限组)
roleId	String	角色ID
userId	String	被授权者用户ID

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
PermissionGroupApi apiInstance = new PermissionGroupApi(token);
//实例化请求参数
AddAuthForm addAuthForm = new AddAuthForm();

try {
    ResultObject result = apiInstance.authPermissionGroup(addAuthForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用PermissionGroupApi.authPermissionGroup异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/permissiongroup/authPermissionGroup
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"userId":"",
	"roleId":""
}

1
2
3
4

# 授权项目

ResultObject authProject(addAuthForm)

授权项目

# 请求参数

名称	类型	描述	备注
addAuthForm	AddAuthForm	addAuthForm

# AddAuthForm

名称	类型	描述
ids	List<String>	被授予的id(项目或者权限组)
roleId	String	角色ID
userId	String	被授权者用户ID

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
PermissionGroupApi apiInstance = new PermissionGroupApi(token);
//实例化请求参数
AddAuthForm addAuthForm = new AddAuthForm();

try {
    ResultObject result = apiInstance.authProject(addAuthForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用PermissionGroupApi.authProject异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/permissiongroup/authProject
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"userId":"",
	"roleId":""
}

1
2
3
4

# 删除授权权限组

ResultObject deleteAuthPermissionGroup(deleteAuthForm)

删除授权权限组

# 请求参数

名称	类型	描述	备注
deleteAuthForm	DeleteAuthForm	deleteAuthForm

# DeleteAuthForm

名称	类型	描述	备注
ids	List<String>	项目id或者权限组id
userId	String	用户ID

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
PermissionGroupApi apiInstance = new PermissionGroupApi(token);
//实例化请求参数
DeleteAuthForm deleteAuthForm = new DeleteAuthForm();

try {
    ResultObject result = apiInstance.deleteAuthPermissionGroup(deleteAuthForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用PermissionGroupApi.deleteAuthPermissionGroup异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/permissiongroup/deleteAuthPermissionGroup
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"userId":""
}

1
2
3

# 删除授权项目

ResultObject deleteAuthProject(deleteAuthForm)

删除授权项目

# 请求参数

名称	类型	描述	备注
deleteAuthForm	DeleteAuthForm	deleteAuthForm

# DeleteAuthForm

名称	类型	描述	备注
ids	List<String>	项目id或者权限组id
userId	String	用户ID

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
PermissionGroupApi apiInstance = new PermissionGroupApi(token);
//实例化请求参数
DeleteAuthForm deleteAuthForm = new DeleteAuthForm();

try {
    ResultObject result = apiInstance.deleteAuthProject(deleteAuthForm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用PermissionGroupApi.deleteAuthProject异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/permissiongroup/deleteAuthProject
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"userId":""
}

1
2
3

# 删除权限组

ResultObject deletePermissionGroup(groupId)

删除权限组

# 请求参数

名称	类型	描述	备注
groupId	String	权限组ID	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
PermissionGroupApi apiInstance = new PermissionGroupApi(token);
//实例化请求参数
String groupId = "groupId_example";

try {
    ResultObject result = apiInstance.deletePermissionGroup(groupId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用PermissionGroupApi.deletePermissionGroup异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/permissiongroup/deletePermissionGroup
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"groupId":""
}

1
2
3

# 获取用户的授权权限组

ResultListPermissionVo getAuthPermissionGroup(userId)

获取用户的授权权限组

# 请求参数

名称	类型	描述	备注
userId	String	用户id	-

# 返回参数

ResultListPermissionVo

名称	类型	描述	备注
code	String	响应码	-
data	List<PermissionVo>	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

PermissionVo

名称	类型	描述	备注
id	String	权限组或者项目ID	-
name	String	权限组或者项目名称	-
roleId	String	角色Id	-
roleName	String	角色名称	-
type	Integer	0 权限组 1项目	-
userId	String	用户Id	-

# java-sdk 调用示例

//实例化api类，传入token
PermissionGroupApi apiInstance = new PermissionGroupApi(token);
//实例化请求参数
String userId = "userId_example";

try {
    ResultListPermissionVo result = apiInstance.getAuthPermissionGroup(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用PermissionGroupApi.getAuthPermissionGroup异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/permissiongroup/getAuthPermissionGroup
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"userId":""
}

1
2
3

# 获取用户的授权项目

ResultListPermissionVo getAuthProject(userId)

获取用户的授权项目

# 请求参数

名称	类型	描述	备注
userId	String	用户id	-

# 返回参数

ResultListPermissionVo

名称	类型	描述	备注
code	String	响应码	-
data	List<PermissionVo>	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

PermissionVo

名称	类型	描述	备注
id	String	权限组或者项目ID	-
name	String	权限组或者项目名称	-
roleId	String	角色Id	-
roleName	String	角色名称	-
type	Integer	0 权限组 1项目	-
userId	String	用户Id	-

# java-sdk 调用示例

//实例化api类，传入token
PermissionGroupApi apiInstance = new PermissionGroupApi(token);
//实例化请求参数
String userId = "userId_example";

try {
    ResultListPermissionVo result = apiInstance.getAuthProject(userId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用PermissionGroupApi.getAuthProject异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/permissiongroup/getAuthProject
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"userId":""
}

1
2
3

# 获取权限组列表

ResultListPermissionGroup getPermissionGroupList()

获取当前用户企业下所有权限组

# 请求参数

请求参数为空.

# 返回参数

ResultListPermissionGroup

名称	类型	描述	备注
code	String	响应码	-
data	List<PermissionGroup>	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

PermissionGroup

名称	类型	描述	备注
companyId	String	企业ID	-
createdBy	String	创建人	-
createdTime	OffsetDateTime	创建时间	-
def	Integer	是否默认 0否 1是	-
disabled	Boolean	是否禁用	-
id	String	主键	-
name	String	名称	-
projects	List<MapStringObject>		-
remark	String	备注	-
updatedTime	OffsetDateTime	修改时间	-

MapStringObject

名称	类型	描述	备注

# java-sdk 调用示例

//实例化api类，传入token
PermissionGroupApi apiInstance = new PermissionGroupApi(token);

try {
    ResultListPermissionGroup result = apiInstance.getPermissionGroupList();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用PermissionGroupApi.getPermissionGroupList异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/permissiongroup/getPermissionGroupList
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{}

# 获取拥有的项目

ResultListPermissionGroup getPermissionGroupProjectTree()

获取拥有的项目

# 请求参数

请求参数为空.

# 返回参数

ResultListPermissionGroup

名称	类型	描述	备注
code	String	响应码	-
data	List<PermissionGroup>	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

PermissionGroup

名称	类型	描述	备注
companyId	String	企业ID	-
createdBy	String	创建人	-
createdTime	OffsetDateTime	创建时间	-
def	Integer	是否默认 0否 1是	-
disabled	Boolean	是否禁用	-
id	String	主键	-
name	String	名称	-
projects	List<MapStringObject>		-
remark	String	备注	-
updatedTime	OffsetDateTime	修改时间	-

MapStringObject

名称	类型	描述	备注

# java-sdk 调用示例

//实例化api类，传入token
PermissionGroupApi apiInstance = new PermissionGroupApi(token);

try {
    ResultListPermissionGroup result = apiInstance.getPermissionGroupProjectTree();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用PermissionGroupApi.getPermissionGroupProjectTree异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/permissiongroup/getPermissionGroupProjectTree
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{}

# 修改权限组

ResultObject updatePermissionGroup(groupId, name)

修改权限组名称

# 请求参数

名称	类型	描述	备注
groupId	String	权限组ID	-
name	String	权限组名称	-

# 返回参数

ResultObject

名称	类型	描述	备注
code	String	响应码	-
data	Object	响应数据	-
msg	String	响应消息	-
time	OffsetDateTime	响应时间	-

# java-sdk 调用示例

//实例化api类，传入token
PermissionGroupApi apiInstance = new PermissionGroupApi(token);
//实例化请求参数
String groupId = "groupId_example";
String name = "name_example";

try {
    ResultObject result = apiInstance.updatePermissionGroup(groupId, name);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("调用PermissionGroupApi.updatePermissionGroup异常: " + e.getMessage());
    e.printStackTrace();
}

1
2
3
4
5
6
7
8
9
10
11
12
13

# HTTP 调用示例

属性	名称
HTTP请求地址	http://[server]:[port]/api-organization/permissiongroup/updatePermissionGroup
请求方式	POST
Content-Type	application/json
header:key	Authorization
header:value	Bearer YOUR_ACCESS_TOKEN

请求参数：

{
	"name":"",
	"groupId":""
}

1
2
3
4

← 变量收藏日志→