获取分享的权限列表

属性	值
HTTP 方法	`GET`
接口路径	`/nd/api/share/share_roles`
所属分类	分享 API

接口说明

获取整个系统的分享权限类型。设置分享参与人角色时，role_id 取自本接口返回数组中所选角色的 roles[].id，参见设置分享参与人的权限角色。

URL 参数

无专用参数。仍需按调用说明携带认证请求头。

返回字段说明

返回对象中的 roles 是角色对象数组。下表列出提供的非空样例中实际出现的字段及 JSON 类型；不据此推定所有字段都必填或始终非空。

字段	样例类型	说明
`id`	`int`	角色 ID；设置分享参与人权限时用作 `role_id`。
`name`	`string`	角色名称；名称可能重复，不能代替 ID。
`description`	`string`	角色说明。
`permission`	`int`	权限数值；不是角色 ID。样例未提供各权限位定义，不根据数值推算操作权限。
`forShare`	`int`	分享相关标记；本次样例中的值均为 `1`。
`forTeamShare`	`int`	团队分享相关标记；样例为 `0` 或 `1`。
`forEnterprise`	`int`	企业相关标记；样例为 `0` 或 `1`。
`roleOrder`	`int`	角色顺序字段；排序方向未说明。
`enterpriseId`	`string`	企业标识；即使值只包含数字，也保留字符串类型。
`creator`	`string` 或 `null`	创建者字段；样例中两种值均出现。
`descriptionEN`	`string`	英文说明字段；实际内容不保证为英文。
`nameEN`	`string`	英文名称字段；实际内容不保证为英文。
`systemdefault`	`int`	样例包含 `0`、`1`、`2`，不是布尔值；各取值的业务含义未在样例中定义。

表格可左右滚动查看

以下沿用已有成功响应外层，仅展示样例中的一个角色，不代表完整角色清单：

{
  "code": 0,
  "roles": [
    {
      "id": 10,
      "name": "批注评论",
      "description": "可以批注评论",
      "permission": 33,
      "forShare": 1,
      "forTeamShare": 1,
      "forEnterprise": 1,
      "roleOrder": 80,
      "enterpriseId": "0",
      "creator": null,
      "descriptionEN": "Comment",
      "nameEN": "Comment",
      "systemdefault": 0
    }
  ],
  "success": true
}

在这个样例中，应选择 role_id: 10，而不是 permission: 33、数组下标或角色名称。实际调用时读取当前返回的 ID，不将示例数值写死为所有部署通用的角色映射。同名角色也应分别按 ID 处理。

本接口提供系统角色列表，不表示当前用户能把其中每个角色授予任意文件。针对具体文件的可设置角色，参见获取用户对于单个文件有权设置的分享角色。

调用说明

调用前需完成获取 token 或相应免登录认证，并在请求 Header 中携带 Authorization: Bearer <access_token>。
参数和返回字段如因部署版本存在差异，应以实际私有云 API 文档和联调结果为准。
所属分类：分享 API。