文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 协同授权/ 获取协同授权列表 - ListAuthed
更新时间:2025-11-25 GMT+08:00
分享

获取协同授权列表 - ListAuthed

功能介绍

协同授权列表。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

auth_level

String

参数解释:

授权主体级别。

约束限制:

不涉及

取值范围:

  • user:用户级别

  • group:用户组级别

默认取值:

不涉及

filter_authed

Boolean

参数解释:

是否过滤已经授权的实体。

约束限制:

不涉及

取值范围:

  • true: 是

  • false: 否

默认取值:

默认true。

resource_id

String

参数解释:

资源ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

resource_type

String

参数解释:

资源类型枚举值,用于指定授权对象的类型。

约束限制:

不涉及

取值范围:

  • datasource:数据源

  • dataset:数据集

  • metric:指标

  • dashboard:仪表板

  • screen:大屏

  • embedAnalysis:嵌入分析

  • portal:数据门户

  • subject:智能分析助手

默认取值:

不涉及

auth_name

String

参数解释:

授权主体名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

limit

Integer

参数解释:

返回条目数(分页大小)。

约束限制:

不涉及

取值范围:

[1, 1000]

默认取值:

20。

offset

Integer

参数解释:

偏移量(分页页数)。

约束限制:

不涉及

取值范围:

[0,1000]

默认取值:

0

sort_dir

String

参数解释:

排序类型。

约束限制:

不涉及

取值范围:

  • asc: 升序

  • desc: 降序

默认取值:

asc

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

参数解释:

工作空间ID。获取方法请参见获取工作空间ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

page_data

Array of CooperateAuthorizationRuleVO objects

分页列表内容。

count

Integer

参数解释:

总条数

取值范围:

不涉及

表5 CooperateAuthorizationRuleVO

参数

参数类型

描述

auth_id

String

参数解释:

授权主体ID。

取值范围:

不涉及

auth_level

String

参数解释:

授权主体级别。

取值范围:

  • user:用户级别

  • group:用户组级别

auth_name

String

参数解释:

授权主体名称。

取值范围:

不涉及

authed

Boolean

参数解释:

是否已授权。

取值范围:

不涉及

authority

String

参数解释:

权限点。

取值范围:

  • edit,export:编辑和导出权限

  • edit:编辑权限

  • export:导出权限

  • use:使用权限

  • read:查看权限

说明:
权限之间有依赖关系
  • 授予edit权限,自动关联授予use、read权限

  • 授予export权限,自动关联授予use、read权限

  • export、edit二者之前无依赖关系

create_date

Long

参数解释:

创建时间。

取值范围:

不涉及

create_user

String

参数解释:

创建人ID。

取值范围:

不涉及

create_user_name

String

参数解释:

创建人姓名。

取值范围:

不涉及

id

String

参数解释:

ID。

取值范围:

不涉及

is_owner

Boolean

参数解释:

是否是资源拥有者。

取值范围:

不涉及

resource_id

String

参数解释:

资源ID。

取值范围:

不涉及

resource_type

String

参数解释:

资源类型枚举值,用于指定授权对象的类型。

取值范围:

  • datasource:数据源

  • dataset:数据集

  • metric:指标

  • dashboard:仪表板

  • screen:大屏

  • embedAnalysis:嵌入分析

  • portal:数据门户

  • subject:智能分析助手

sort

Integer

参数解释:

排序字段。

取值范围:

不涉及

update_date

Long

参数解释:

修改时间。

取值范围:

不涉及

update_user

String

参数解释:

修改人ID。

取值范围:

不涉及

update_user_name

String

参数解释:

修改人姓名。

取值范围:

不涉及

请求示例

获取协同授权列表。

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。

错误码

请参见错误码

相关文档