角色管理-阿里云帮助中心

获取组织角色列表

接口：/openapi/v2/organization/customRole/list (GET)
描述：获取组织中的角色列表。（起始版本：独立部署v5.0.3）
输入参数：无需传参

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object []	返回标签元信息列表。
roleId	long	角色ID。
roleName	string	角色名称。
authConfigList	List	角色配置。
authKey	string	权限类型： quick_monitor：指标监控 subscription：订阅管理 offline_download：自助取数 resource_package：资源包管理 organization_ask：组织识别码（AK/SK） developer_openapi：开放API data_service：数据服务 admin_authorize3rd：嵌入分析 component_manage：自定义组件 template_open：自定义模板 custom_driver：自定义驱动（增值功能） open_platform_custom_plugin：自定义插件（增值功能） enterprise_safety：企业安全
actionAuthKeys	List<String>	空间资源的权限点列表，在该API中未使用到，无需关心
systemRole	boolean	是否是预置角色。取值范围： true：是 false：否

返回参数示例：

{
    "traceId": "6a1e98a9-eaf5-48b8-bc48-fef74ee34ef1",
    "code": null,
    "message": null,
    "data": [
        {
            "systemRole": true,
            "roleId": 111111111,
            "roleName": "组织管理员",
            "authConfigList": [
                {
                    "authKey": "open_platform_custom_plugin"
                },
                {
                    "authKey": "offline_download"
                },
                {
                    "authKey": "enterprise_safety"
                },
                {
                    "authKey": "quick_monitor"
                },
                {
                    "authKey": "subscription"
                },
                {
                    "authKey": "resource_package"
                },
                {
                    "authKey": "organization_ask"
                },
                {
                    "authKey": "developer_openapi"
                },
                {
                    "authKey": "data_service"
                },
                {
                    "authKey": "admin_authorize3rd"
                },
                {
                    "authKey": "component_manage"
                },
                {
                    "authKey": "template_open"
                },
                {
                    "authKey": "custom_driver"
                }
            ]
        },
        {
            "systemRole": true,
            "roleId": 111111112,
            "roleName": "权限管理员",
            "authConfigList": [
                {
                    "authKey": "offline_download"
                },
                {
                    "authKey": "enterprise_safety"
                },
                {
                    "authKey": "quick_monitor"
                },
                {
                    "authKey": "subscription"
                },
                {
                    "authKey": "developer_openapi"
                },
                {
                    "authKey": "data_service"
                },
                {
                    "authKey": "admin_authorize3rd"
                }
            ]
        },
        {
            "systemRole": true,
            "roleId": 111111113,
            "roleName": "普通用户",
            "authConfigList": [
                {
                    "authKey": "offline_download"
                },
                {
                    "authKey": "quick_monitor"
                },
                {
                    "authKey": "subscription"
                },
                {
                    "authKey": "developer_openapi"
                },
                {
                    "authKey": "data_service"
                },
                {
                    "authKey": "admin_authorize3rd"
                }
            ]
        },
        {
            "systemRole": false,
            "roleId": 656704594,
            "roleName": "企业安全",
            "authConfigList": [
                {
                    "authKey": "offline_download"
                }
            ]
        }
    ],
    "success": true
}

JAVA SDK 示例：

public static void listOrganizationRoles() throws SDKException {
    HttpRequest request = HttpRequest.build()
            .setUri("/openapi/v2/organization/customRole/list")
            .setMethod(HttpMethod.GET);
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

获取指定组织角色的配置信息

接口：/openapi/v2/organization/customRole/config (GET)
描述：获取指定组织角色的配置信息。（起始版本：独立部署v5.0.3）

输入参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)

参数

类型

描述

是否必需

roleId

long

组织角色ID，包括预置角色和自定义角色：

组织管理员（预置角色）：111111111
权限管理员（预置角色）：111111112
普通用户（预置角色）：111111113
自定义角色：自定义角色对应的角色ID

是

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object	返回标签元信息列表。
roleId	long	组织角色ID，包括预置角色和自定义角色：组织管理员（预置角色）：111111111 权限管理员（预置角色）：111111112 普通用户（预置角色）：111111113 自定义角色：自定义角色对应的角色ID
roleName	string	角色名称。
authConfigList	List
authKey	string	权限类型： quick_monitor：指标监控 subscription：订阅管理 offline_download：自助取数 resource_package：资源包管理 organization_ask：组织识别码（AK/SK） developer_openapi：开放API data_service：数据服务 admin_authorize3rd：嵌入分析 component_manage：自定义组件 template_open：自定义模板 custom_driver：自定义驱动（增值功能） open_platform_custom_plugin：自定义插件（增值功能） enterprise_safety：企业安全
actionAuthKeys	List<String>	空间资源的权限点列表，在该API中为使用到，无需关心
systemRole	boolean	是否是预置角色。取值范围： true：是 false：否

返回参数示例：

{
    "traceId": "6a1e98a9-eaf5-48b8-bc48-fef74ee34ef1",
    "code": null,
    "message": null,
    "data": {
        "systemRole": true,
        "roleId": 111111111,
        "roleName": "组织管理员",
        "authConfigList": [
            {
                "authKey": "open_platform_custom_plugin"
            },
            {
                "authKey": "offline_download"
            },
            {
                "authKey": "enterprise_safety"
            },
            {
                "authKey": "quick_monitor"
            },
            {
                "authKey": "subscription"
            },
            {
                "authKey": "resource_package"
            },
            {
                "authKey": "organization_ask"
            },
            {
                "authKey": "developer_openapi"
            },
            {
                "authKey": "data_service"
            },
            {
                "authKey": "admin_authorize3rd"
            },
            {
                "authKey": "component_manage"
            },
            {
                "authKey": "template_open"
            },
            {
                "authKey": "custom_driver"
            }
        ]
    },
    "success": true
}

JAVA SDK 示例：

public static void queryOrganizationRoleConfig() throws SDKException {
    HttpRequest request = HttpRequest.build()
            .setUri("/openapi/v2/organization/customRole/config")
            .setMethod(HttpMethod.GET)
            .setHttpContentType(FormatType.FORM);
    request.addParameter("roleId","111111111");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

获取指定组织角色下的用户列表

接口：/openapi/v2/organization/customRole/users (GET)
描述：获取指定组织角色下的用户列表。（起始版本：独立部署v5.0.3）

输入参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)

参数	类型	描述	是否必需
roleId	long	组织角色ID，包括预置角色和自定义角色：组织管理员（预置角色）：111111111 权限管理员（预置角色）：111111112 普通用户（预置角色）：111111113 自定义角色：自定义角色对应的角色ID	是
pageNum	integer	页码。默认值1。	否
pageSize	integer	每页行数。默认值10。	否
keyword	string	组织成员昵称的关键字。	否

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object[]	返回标签元信息列表。
userId	string	组织成员在Quick BI的UserID。
nickName	string	组织成员的昵称。

返回参数示例：

{
    "traceId": "6a1e98a9-eaf5-48b8-bc48-fef74ee34ef1",
    "code": null,
    "message": null,
    "data": {
        "data": [
            {
                "nickName": "yubai@xx.com",
                "userId": "408d9d79dddb4xxxx87332e8a19ae"
            },
            {
                "nickName": "yubai_xx删",
                "userId": "b4b9e2199c7xxxx414fce51ec1522"
            },
            {
                "nickName": "yubai",
                "userId": "0e9f596e3e9xxxxd11c4debd81c8"
            }
        ],
        "totalNum": 3,
        "totalPages": 1,
        "start": 0,
        "pageSize": 10,
        "pageNum": 1
    },
    "success": true
}

JAVA SDK 示例：

public static void listOrganizationRoleUsers() throws SDKException {
  HttpRequest request = HttpRequest.build()
          .setUri("/openapi/v2/organization/customRole/users")
          .setMethod(HttpMethod.GET)
          .setHttpContentType(FormatType.FORM);
  request.addParameter("roleId","111111111");
  // 非必填参数
  request.addParameter("pageNum","1");
  request.addParameter("pageSize","10");
  request.addParameter("keyword","yubai");
  String result = openApiClient.syncExecute(request);
  System.out.println(result);
}

获取空间角色列表

接口：/openapi/v2/workspace/customRole/list (GET)
描述：获取空间角色列表。（起始版本：独立部署v5.0.3）
输入参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)
参数
类型
描述
是否必需
workspaceId
string
工作空间ID。
是

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object[]	返回标签元信息列表。
roleId	long	空间角色ID，包括预置角色和自定义角色： 25：空间管理员（预置角色） 26：开发者（预置角色） 27：分析者（预置角色） 30：阅览者（预置角色）自定义角色：自定义角色对应的角色ID
roleName	string	角色名称。
authConfigList	List
authKey	string	权限类型： portal_create：数据门户 dashboard_create：仪表板 report_create：电子表格 screen_create：数据大屏 analysis：即席分析 offline_download：自助取数 data_form：数据填报 quick_etl：数据准备 cube：数据集 datasource：数据源
actionAuthKeys	List<String>	具体的权限： edit：新建 use：使用 list：展示列表
systemRole	boolean	是否是预置角色。取值范围： true：是 false：否

返回参数示例：

{
    "traceId": "6a1e98a9-eaf5-48b8-bc48-fef74ee34ef1",
    "code": null,
    "message": null,
    "data": [
        {
            "systemRole": true,
            "roleId": 25,
            "roleName": "空间管理员",
            "authConfigList": [
                {
                    "authKey": "portal_create",
                    "actionAuthKeys": [
                        "edit",
                        "list"
                    ]
                },
                {
                    "authKey": "dashboard_create",
                    "actionAuthKeys": [
                        "edit",
                        "list"
                    ]
                },
                {
                    "authKey": "report_create",
                    "actionAuthKeys": [
                        "edit",
                        "list"
                    ]
                },
                {
                    "authKey": "screen_create",
                    "actionAuthKeys": [
                        "edit",
                        "list"
                    ]
                },
                {
                    "authKey": "analysis",
                    "actionAuthKeys": [
                        "edit",
                        "list"
                    ]
                },
                {
                    "authKey": "offline_download",
                    "actionAuthKeys": [
                        "edit",
                        "list"
                    ]
                },
                {
                    "authKey": "data_form",
                    "actionAuthKeys": [
                        "edit",
                        "list"
                    ]
                },
                {
                    "authKey": "quick_etl",
                    "actionAuthKeys": [
                        "edit",
                        "list"
                    ]
                },
                {
                    "authKey": "cube",
                    "actionAuthKeys": [
                        "edit",
                        "use",
                        "list"
                    ]
                },
                {
                    "authKey": "datasource",
                    "actionAuthKeys": [
                        "edit",
                        "use",
                        "list"
                    ]
                }
            ]
        }
    ],
    "success": true
}

JAVA SDK 示例：

public static void listWorkspaceRoles() throws SDKException {
    HttpRequest request = HttpRequest.build()
            .setUri("/openapi/v2/workspace/customRole/list")
            .setMethod(HttpMethod.GET)
            .setHttpContentType(FormatType.FORM);
    request.addParameter("workspaceId","2a687137-b1b7-491a-a421-b2b9d0e03f6e");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

获取指定空间角色的配置信息

接口：/openapi/v2/workspace/customRole/config (GET)
描述：获取指定空间角色的配置信息。（起始版本：独立部署v5.0.3）

输入参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)

参数

类型

描述

是否必需

roleId

long

空间角色ID，包括预置角色和自定义角色：

25：空间管理员（预置角色）
26：开发者（预置角色）
27：分析者（预置角色）
30：阅览者（预置角色）
自定义角色：自定义角色对应的角色ID

是

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object	返回标签元信息列表。
roleId	long	空间角色ID，包括预置角色和自定义角色： 25：空间管理员（预置角色） 26：开发者（预置角色） 27：分析者（预置角色） 30：阅览者（预置角色）自定义角色：自定义角色对应的角色ID
roleName	string	角色名称。
authConfigList	List	角色配置。
authKey	string	权限类型： portal_create：数据门户 dashboard_create：仪表板 report_create：电子表格 screen_create：数据大屏 analysis：即席分析 offline_download：自助取数 data_form：数据填报 quick_etl：数据准备 cube：数据集 datasource：数据源
actionAuthKeys	List<String>	具体的权限： edit：新建 use：使用 list：展示列表
systemRole	boolean	是否是预置角色。取值范围： true：是 false：否

返回参数示例：

{
    "traceId": "6a1e98a9-eaf5-48b8-bc48-fef74ee34ef1",
    "code": null,
    "message": null,
    "data": {
        "systemRole": true,
        "roleId": 25,
        "roleName": "空间管理员",
        "authConfigList": [
            {
                "authKey": "portal_create",
                "actionAuthKeys": [
                    "edit",
                    "list"
                ]
            },
            {
                "authKey": "dashboard_create",
                "actionAuthKeys": [
                    "edit",
                    "list"
                ]
            },
            {
                "authKey": "report_create",
                "actionAuthKeys": [
                    "edit",
                    "list"
                ]
            },
            {
                "authKey": "screen_create",
                "actionAuthKeys": [
                    "edit",
                    "list"
                ]
            },
            {
                "authKey": "analysis",
                "actionAuthKeys": [
                    "edit",
                    "list"
                ]
            },
            {
                "authKey": "offline_download",
                "actionAuthKeys": [
                    "edit",
                    "list"
                ]
            },
            {
                "authKey": "data_form",
                "actionAuthKeys": [
                    "edit",
                    "list"
                ]
            },
            {
                "authKey": "quick_etl",
                "actionAuthKeys": [
                    "edit",
                    "list"
                ]
            },
            {
                "authKey": "cube",
                "actionAuthKeys": [
                    "edit",
                    "use",
                    "list"
                ]
            },
            {
                "authKey": "datasource",
                "actionAuthKeys": [
                    "edit",
                    "use",
                    "list"
                ]
            }
        ]
    },
    "success": true
}

JAVA SDK 示例：

public static void queryWorkspaceRoleConfig() throws SDKException {
    HttpRequest request = HttpRequest.build()
            .setUri("/openapi/v2/workspace/customRole/config")
            .setMethod(HttpMethod.GET)
            .setHttpContentType(FormatType.FORM);
    request.addParameter("roleId","25");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}

获取指定空间角色下的用户列表

接口：/openapi/v2/workspace/customRole/users (GET)
描述：获取组织中的角色列表。（起始版本：独立部署v5.0.3）

输入参数：(content-type:application/x-www-form-urlencoded;charset=UTF-8，参数以表单提交)

参数	类型	描述	是否必需
roleId	long	空间角色ID，包括预置角色和自定义角色： 25：空间管理员（预置角色） 26：开发者（预置角色） 27：分析者（预置角色） 30：阅览者（预置角色）自定义角色：自定义角色对应的角色ID	是
workspaceId	string	工作空间ID，非必填，不传时，返回所有空间的角色。	否
pageNum	integer	分页查询时的当前页：起始值：1 默认值：1	否
pageSize	integer	分页查询时的每页行数：默认值：10 最大值：1000	否
keyword	string	用户昵称的关键字。	否

返回参数说明（SDK调用时，仅返回data部分）：

参数	类型	描述
traceId	string	请求ID。
code	string	抛错码。取值范围： 0：调用成功 AE或OE开头的异常码：调用失败
message	string	抛错信息。取值范围： success：调用成功其他信息：调用失败时的提示
success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败
data	object	返回标签元信息列表。
totalNum	integer	总行数。
totalPages	integer	总页数。
pageNum	integer	页码。
pageSize	integer	请求接口时设置的每页行数。
data	object[]	用户列表。
nickName	string	组织成员的昵称。
userId	String	组织成员在Quick BI的UserID。
workspaceId	String	工作空间ID。
workspaceName	String	工作空间名称。

返回参数示例：

{
    "traceId": "6a1e98a9-eaf5-48b8-bc48-fef74ee34ef1",
    "code": null,
    "message": null,
    "data": {
        "data": [
            {
                "nickName": "杨xx",
                "workspaceName": "测评空间",
                "userId": "247d405cbdxxxdaf0347b03ef2d75c",
                "workspaceId": "308b9461-4xxx-xxx-98ed-d80a4a27257b"
            }
        ],
        "totalNum": 3,
        "totalPages": 1,
        "start": 0,
        "pageSize": 10,
        "pageNum": 1
    },
    "success": true
}

JAVA SDK 示例：

public static void listWorkspaceRoleUsers() throws SDKException {
    HttpRequest request = HttpRequest.build()
            .setUri("/openapi/v2/workspace/customRole/users")
            .setMethod(HttpMethod.GET)
            .setHttpContentType(FormatType.FORM);
    request.addParameter("roleId","25");
    // 非必填参数
    request.addParameter("workspaceId","308b9461-4e60-****-98ed-d80a4a27257b");
    request.addParameter("pageNum","1");
    request.addParameter("pageSize","10");
    //request.addParameter("keyword","xxx");
    String result = openApiClient.syncExecute(request);
    System.out.println(result);
}