跳转至

1、 接口概述

本接口是用于撤销用户的权限

2、 接口请求地址

POST Http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/authority/revoke

anymetrics_host:anymetrics_port 获取方式请参考:调用方式

3、 请求参数

3.1 公共请求参数(HEADERS)

参数 类型 是否必选 最大长度 描述
tenant-id String 32 当前租户ID
auth-type String 32 认证方式。支持 UIDTOKENACCOUNTAPIKEY
auth-value String 32 auth-type 对应的认证值

3.2.1 公共参数获取方式

tenant-id 可在 Aloudata CAN 顶部导航栏选择指标应用,左边菜单栏选择 API 集成,在 API 集成界面获取;auth-value 请按 auth-type 填写对应认证值。

3.2 请求参数

参数 类型 是否必选 描述 示例值
revokedEntities List 被撤销用户的userId列表 ["336178570944581632"]
resources [Object] 新参数,批量资源,必须限定同一resourceType [resource]
authorityRole String 需要撤销的权限角色,详情见:AuthorityRoleEnum ADMIN
expiredTime Long 过期时间,单位天 10

3.2.1 revokedEntities

参数名 类型 是否必填 描述 示例
ids [String] 被撤销对象标识 ["11223"]
authorizedEntityType String 被撤销对象类型 USER、USER_GROUP
idType String 被撤销对象标识的类型 用户:USER_ACCOUNT、USER_ID
用户组:USER_GROUP_ID、USER_GROUP_CODE

3.2.3 AuthorityRoleEnum

参数 说明
AuthorityRoleEnum 枚举值为:OWNER,ADMIN,USAGEROWNER(不可主动被授权):可授权ADMIN,USAGER,ADMIN:管理员,可授权USAGEUSAGER:使用者CREATOR: 可新建

3.2.4 resource

参数 类型 是否必选 描述
resourceType ResourceTypeEnum 被授权的资源类型,枚举值如下:
- TENANT:租户
- VIEW:分析视图
- DATASET:数据集
- METRIC:指标
- DIMENSION:维度
- CATEGORY_METRIC:指标类目
- CATEGORY_DATASET:数据集类目
- CATEGORY_RESULT_PLAN:结果加速类目
- DATASOURCE:数据源
- DATABASE:数据源数据库
- TABLE:数据源表
resourceId String 资源 ID,每个类型
资源TENANT:资源ID为:租户ID,示例:tn_12345
TENANT:资源ID为租户ID,示例:tn_12345
DATASET:资源 ID 为数据集名称,示例:order
METRIC:资源 ID 为指标code,示例:uv_7day
DIMENSION: 资源 ID 位维度 code,示例:dmfa48e4cb69c60912210bc5162ff324
VIEW:资源 ID 为视图名称,示例:order_view
CATEGORY_METRIC:资源 ID指标类目名称
CATEGORY_DATASET:资源 ID数据集类目名称
CATEGORY_RESULT_PLAN:资源 ID结果加速类目名称
DATASOURCE:数据源,示例:default_catalog
DATABASE:数据源数据库,示例:aloudata_datasource.60default_catalog.aloudatacan
TABLE:数据源表:aloudata_datasource.60default_catalog.aloudatacan.API_MZTEST

3.3 资源点权限说明

类型 是否必选 描述
TENANT(租户) OWNER 包含权限点:租户授权,撤权,编辑,使用数据集,指标,分析视图的创建权限
ADMIN 包含权限点:租户授权,撤权,编辑,使用数据集,指标,分析视图的创建权限
USAGER 包含权限点:租户使用
DATASET(数据集) OWNER 包含权限点:数据集授权,撤权,删除,编辑,使用
ADMIN 包含权限点:数据集授权,撤权,编辑,使用
USAGER 包含权限点:数据集使用
METRIC(指标) OWNER 包含权限点:指标授权,撤权,删除,编辑,使用
ADMIN 包含权限点:指标授权,撤权,编辑,使用
USAGER 包含权限点:指标使用
METRIC(指标) OWNER 包含权限点:维度授权,撤权,删除,编辑,使用
ADMIN 包含权限点:维度授权,撤权,编辑,使用
USAGER 包含权限点:维度使用
ANALYSIS_VIEW(分析视图) OWNER 包含权限点:指标授权,撤权,删除,编辑,使用
ADMIN 包含权限点:指标授权,撤权,编辑,使用
USAGER 包含权限点:指标使用
CATEGORY_METRIC OWNER 包含权限点:指标类目授权,撤权,删除,编辑,使用,数据集类目下新指标
ADMIN 包含权限点:指标类目授权,撤权,编辑,使用,数据集类目下新指标
USAGER 包含权限点:指标类目使用
CREATOR 包含权限点:数据集类目下新指标
CATEGORY_DATASET OWNER 包含权限点:数据集类目授权,撤权,删除,编辑,使用,类目下新建指标
ADMIN 包含权限点:数据集类目授权,撤权,编辑,使用,类目下新建指标
USAGER 包含权限点:数据集类目类目使用
CREATOR 包含权限点:数据集类目下新建数据集
CATEGORY_RESULT_PLAN OWNER 包含权限点:结果加速类目授权,撤权,删除,编辑,使用,类目下新建结果加速
ADMIN 包含权限点:结果加速类目授权,撤权,编辑,使用
USAGER 包含权限点:结果加速类目使用
CREATOR 包含权限点:结果加速类目下新建结果加速
DATASOURCE OWNER 包含权限点:数据源授权,撤权,使用
ADMIN 包含权限点:授权,撤权,使用
USAGER 包含权限点:数据源使用
DATABASE OWNER 包含权限点:数据库使用,撤权,使用
ADMIN 包含权限点:数据库授权,撤权,使用
USAGER 包含权限点:数据库使用
TBALE OWNER 包含权限点:数据源表授权,撤权,使用
ADMIN 包含权限点:数据源表授权,撤权,使用
USAGER 包含权限点:数据源表使用

4、 响应参数

参数 类型 是否必选 最大长度 描述 示例值
code String 32 接口响应码 200
success boolean 是否成功 true
errorMsg String 512 报错信息 null
detailErrorMsg String 报错详情 null
traceId String 128 traceId 343f9ff2dcd70.292.16857691758642861
data Boolean 是否授权成功 true

5、 请求示例

  • 请求
{
    "revokedEntities": {
        "ids": [
            "648550115602075648"
        ],
        "authorizedEntityType": "USER",
        "idType": "USER_ID"
    },
    "authorityRole":"ADMIN",
     "resource": {
        "resourceType": "METRIC",
        "resourceId": "mc72e6349d495d4400b7b0590e65ff30"
    }
}
  • 响应
{
    "data": true,
    "success": true,
    "code": "200",
    "errorMsg": null,
    "detailErrorMsg": null,
    "traceId": "2bc7df9f294144deab6535e0b2a9b546.154.17234535618741285"
}