更新时间:2025-03-14 GMT+08:00

按条件列举权限模板

功能介绍

按条件列举权限模板

URI

GET /koodrive/ose/v1/permission/template/list

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

最大返回个数。最小值为1,最大值为100

offset

Integer

偏移量,最小值为0

id

Long

权限模板的唯一id。

templateType

Integer

权限模板的类型;0是预置模板,1是自定义模板。

status

Integer

权限模板的状态;0是禁用,1是启用。

orderByTime

Integer

按createTime排序,0表示降序,1表示升序,该值仅能填0或1。

preBefore

Boolean

规定预置模板排在前还是后

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取

X-User-Id

String

用户id,用于app鉴权

X-Date

String

日期,用于app鉴权

Host

String

地址,用于app鉴权

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

code

Integer

响应码

msg

String

响应信息

data

Array of PermissionTemplate objects

权限模板信息

total

Integer

当前企业下权限模板总数(包括预置模板)

表4 PermissionTemplate

参数

参数类型

描述

id

String

权限模板的唯一id。

name

String

权限模板的名称。

description

String

权限模板的描述信息。

templateType

Integer

权限模板的类型;0是预置模板,1是自定义模板。

status

Integer

权限模板的状态;0是禁用,1是启用。

company

String

权限模板归属的企业。可以是orgid,也可以是appid。

createTime

String

权限模板的创建时间。

updateTime

String

权限模板的更新时间。

capabilities

Capabilities object

权限值。

表5 Capabilities

参数

参数类型

描述

addChildNodePermission

Boolean

新建文件/文件夹权限;true有权限,false无权限。

copyPermission

Boolean

复制权限;true有权限,false无权限。

deletePermission

Boolean

删除权限;true有权限,false无权限。

downloadPermission

Boolean

下载权限;true有权限,false无权限。

editPermission

Boolean

编辑权限;true有权限,false无权限(暂不支持编辑)。

listChildNodePermission

Boolean

可见列表权限;true有权限,false无权限。

removeChildNodePermission

Boolean

移动权限;true有权限,false无权限。

renameFilePermission

Boolean

重命名权限;true有权限,false无权限。

shareFilePermission

Boolean

分享权限;true有权限,false无权限。

uploadPermission

Boolean

上传权限;true有权限,false无权限。

viewPermission

Boolean

预览权限;true有权限,false无权限。

请求示例

/koodrive/cloudfile/v1/permission/template/list?offset=0&limit=20&orderByTime=0&templateType=1

Authorization:Bearer+10f88**********4791e9f

响应示例

状态码:200

响应体

{
  "total" : 1,
  "data" : [ {
    "id" : "***",
    "name" : "*****",
    "description" : "",
    "templateType" : 1,
    "status" : 1,
    "company" : "*****",
    "createTime" : "2025-01-03T08:15:14.339Z",
    "updateTime" : "2025-01-03T08:54:47.814Z",
    "capabilities" : {
      "addChildNodePermission" : false,
      "copyPermission" : false,
      "deletePermission" : false,
      "downloadPermission" : false,
      "editPermission" : false,
      "listChildNodePermission" : true,
      "removeChildNodePermission" : false,
      "renameFilePermission" : false,
      "shareFilePermission" : false,
      "uploadPermission" : false,
      "viewPermission" : false
    }
  } ],
  "code" : 0,
  "msg" : "成功"
}

状态码

状态码

描述

200

响应体