文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 协同授权/ 获取协同授权列表
更新时间：2024-07-31 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取协同授权列表

功能介绍

协同授权列表。

URI

GET /v1/{project_id}/authorization/cooperate-authorization/rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参考获取项目ID。

最小长度：0

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

auth_level

否

String

授权主体级别。

  • user：用户
  • group：用户组

最小长度：0

最大长度：128

filter_authed

否

Boolean

是否过滤已经授权的实体，默认true，仅显示授权用户和用户组信息。

预留字段。

最小长度：0

最大长度：128

resource_id

是

String

资源ID。

最小长度：0

最大长度：128

resource_type

是

String

资源类型：

  • Datasource：数据源。
  • Dataset：数据集。
  • Dashboard：仪表板。
  • Screen：大屏。
  • Subject：智能分析助手。

最小长度：0

最大长度：128

auth_name

否

String

授权主体名称。

最小长度：0

最大长度：128

limit

否

Integer

分页大小。

最小值：1

最大值：1000

offset

否

Integer

偏移量。

最小值：0

最大值：1000

sort_dir

否

String

asc: 升序， desc: 降序。

最小长度：0

最大长度：128

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

是

String

工作空间ID，即控制台的项目ID。

可以通过查询工作空间获取工作空间ID。

最小长度：0

最大长度：128

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。

最小长度：0

最大长度：8192

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

page_data

Array of objects

分页列表内容。详细参数类型请参考CooperateAuthorizationRuleVO 。

数组长度：0 -1000000

count

Integer

总条数。

最小值：0

最大值：2147483647
表5 CooperateAuthorizationRuleVO

参数

参数类型

描述

auth_id

String

授权主体ID。

auth_level

String

授权主体级别。

  • user：用户
  • group：用户组

最小长度：0

最大长度：128

auth_name

String

授权主体名称。

最小长度：0

最大长度：128

authed

Boolean

是否已授权。

authority

String

权限点，枚举值。

  • edit、export：编辑和导出权限
  • edit：编辑权限
  • export：导出权限
  • read：查看权限
  • use：使用权限
    说明：

    权限之间有依赖关系，

    • 授予edit权限，自动关联授予use、read权限；
    • 授予了export权限，自动关联授予use、read权限。
    • export、edit二者之前无依赖关系。

最小长度：0

最大长度：128

create_date

Long

创建时间。

最小值：0

最大值：9007199254740991

create_user

String

创建人ID。

最小长度：0

最大长度：128

create_user_name

String

创建人姓名。

最小长度：0

最大长度：128

id

String

授权记录的ID，无实际含义。

最小长度：0

最大长度：128

is_owner

Boolean

是否是资源拥有者。

最小长度：0

最大长度：128

resource_id

String

资源ID。

最小长度：0

最大长度：128

resource_type

String

资源类型。

  • Datasource：数据源。
  • Dataset：数据集。
  • Dashboard：仪表板。
  • Screen：大屏
  • Subject：智能分析助手。

sort

Integer

排序字段，无实际含义。

最小值：0

最大值：2147483647

update_date

Long

修改时间。

最小值：0

最大值：9007199254740991

update_user

String

修改人ID。

最小长度：0

最大长度：128

update_user_name

String

修改人姓名。

最小长度：0

最大长度：128

请求示例

获取协同授权列表。

GET https://{endpoint}/v1/xxxx3ab4dac4055888643b331axxxx/authorization/cooperate-authorization/rules?resource_type=dataset&resource_id=f8e5406b-8662-4adb-a028-a55c76ae1166&auth_level=user&filer_authed=false&limit=20&offset=0&sort_dir=asc

响应示例

状态码： 200

OK。

{
  "page_data" : [ {
    "create_date" : 1690593374608,
    "create_user" : "xxxxxf45cea249a2aa648a20e46xxxxx",
    "create_user_name" : "xxxxxx",
    "update_date" : 1690593374608,
    "update_user" : "558def45cea249a2aa648a20e46xxxxx",
    "update_user_name" : "xxxxx",
    "id" : "73281a3b-a828-494a-bb0d-e88c688a5e81",
    "resource_type" : "dashboard",
    "resource_id" : "e3158b30-30bc-495a-b0d8-59e66e1xxxxx",
    "auth_level" : "user",
    "auth_id" : "xxxxf45cea249a2aa648a20e46xxxx",
    "auth_name" : "xxxxxx",
    "is_owner" : true,
    "authed" : true,
    "sort" : 4,
    "authority" : "edit"
  }, {
    "create_date" : 1690593374608,
    "create_user" : "xxxxxf45cea249a2aa648a20e46xxxxx",
    "create_user_name" : "xxxxxx",
    "update_date" : 1690593374608,
    "update_user" : "558def45cea249a2aa648a20e46xxxxx",
    "update_user_name" : "xxxxx",
    "id" : "73281a3b-a828-494a-bb0d-e88c688a5e81",
    "resource_type" : "dashboard",
    "resource_id" : "e3158b30-30bc-495a-b0d8-59e66e1xxxxx",
    "auth_level" : "user",
    "auth_id" : "xxxxf45cea249a2aa648a20e46xxxx",
    "auth_name" : "xxxxxx",
    "is_owner" : true,
    "authed" : true,
    "sort" : 4,
    "authority" : "edit,export"
  } ],
  "count" : 2147483647
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 协同授权

相关文档