You need to enable JavaScript to run this app.
ByteHouse Cloud Data Warehouse Version

ByteHouse Cloud Data Warehouse Version

Copy page
Download PDF
Access Control
Role management
Copy page
Download PDF
Role management

The permission control model of ByteHouse Cloud Data Warehouse Edition is primarily based on the RBAC permission control model. It enables fine-grained permission management for resources and data through roles. This document introduces the role management capabilities in ByteHouse, as well as how to create custom roles, grant, and revoke role permissions.

Background information

Basic concepts

Terminology

Concepts

Permissions

All actions that can be performed in ByteHouse are defined with corresponding permissions. For example: viewing account resource usage, creating new users, querying data from a table, or loading large datasets into ByteHouse.
Permissions related to specific resources, such as creating tables (related to databases), inserting new data (related to tables), and running virtual warehouses (related to warehouses), are bound to specific resource instances or objects.
Other permissions, such as creating databases (note: databases are account-level resources), viewing billing status, or creating new service users, are not bound to any specific object.

Roles

Permission control in ByteHouse is performed at the role level. Each ByteHouse user can be assigned one or more roles.

For more information about ByteHouse's permission control logic and concepts, see Overview.

Built-in roles and custom roles

ByteHouse provides system default roles, and you can also create custom roles based on business requirements to flexibly manage role permissions.

Role types

Permission description

System default roles

  • Account administrator (AccountAdmin): The default role for the primary account; it is the root role of the ByteHouse account and is not granted to other sub-users.
  • System administrator (SystemAdmin): The direct sub-role of the account administrator. Users with this role will have permissions for all platform resources, such as databases, tables, virtual warehouses, online worksheets, and more. The permission scope is equivalent to the ByteHouseFullAccess IAM policy. If this role is granted to a sub-user, the sub-user will have all operational permissions in ByteHouse (excluding unsubscription).

Custom roles

Custom roles are created within ByteHouse cloud data warehouse and can be granted the necessary permissions for ByteHouse cloud data warehouse resources and data.

Under the AccountAdmin role, you can click the "Permission Management - Roles" page in the top navigation to view all available roles in the account.
Image

Caution

Only the primary account or sub-accounts with the AccountAdmin or SystemAdmin role and ByteHouse console access permissions can perform operations such as creating roles and granting role permissions in the ByteHouse console.

Create custom roles

To meet complex business team organizational needs where built-in roles cannot satisfy permission control requirements, create suitable custom roles for each business team by clicking "Create Role" on the role management page according to the actual situation of your business teams.
Image

Set role permission scope

After creating a custom role, you can go to the "Permission Management - Roles" page, click to enter the details page of the specific role, and grant resource permissions and data permissions to the role respectively.

Resource permissions

Image

Resource permission breakdown

Permission configuration description

Create database

After turning on the switch, the role will have permissions to create databases and browse all databases.

Create external catalog

After turning on the switch, the role will have permissions to create, delete, and view external catalogs.

Data loading management

After enabling the switch, the role will have all functional permissions of the data import module, including creating, editing, and deleting import tasks, as well as creating, editing, and deleting data sources.

Knowledge base management

After enabling the switch, the role will have permissions to create, view, and manage knowledge bases.

Compute group management

By default, custom roles have VIEW permission for compute groups. You can configure whether the role has USE or ALL permissions for compute groups as needed, and you can also set whether the scope of compute groups controlled by the role is a specific compute group or all compute groups.

  • VIEW: Allows viewing compute groups and query history
  • USE: Allows using compute groups for queries and restoring compute groups when "Auto Recovery" is enabled
  • ALL: Grants all permissions for compute groups

Global audit logs

After enabling the switch, the role will have permission to view global audit logs, including SQL history, running queries, permission audits, compute group audits, and user activities. Sub-users with this role can directly view all sub-users' global audit log information.

Data permissions

Supports setting permission points for global, database, data table, view, materialized view, dictionary, external Catalog, and UDF.
Image

Data permission granularity

Permission configuration instructions

Global

Select the permission points to grant. After granting global permissions, all data objects in the environment will be granted the selected permission points.

Database

Select the databases to authorize and grant database permission points.

Data table

Select the databases and their data tables to authorize, and grant data table permission points.

View

Select the databases and their views to authorize, and grant view permission points.

Materialized view

Select the databases and their materialized views to authorize, and grant materialized view permission points.

Dictionary

Select the databases and their dictionaries to authorize, and grant dictionary permission points.

UDF

Select the UDF permission points to grant.

External Catalog

Select the external Catalogs to authorize and grant the corresponding permission points.

Grant roles to users

After completing the role permission settings, go to the role details page, click "Grant to User", select a user from the dropdown, and grant the role permissions to the specified user.
Image

tip

Here, you can assign default or custom roles to the corresponding Volcano Engine IAM sub-users.

After granting, you can view which users have been granted the role in the Granted Users list of the role.
Image

Revoke role permissions

You can click the role name on the role management page to enter the role details page. On the "Granted users" tab, click the Revoke button to the right of the user and confirm to revoke the user's role assignment.
Image

Last updated: 2026.03.31 15:29:30