Manage custom roles - ClickHouse Documentation

This guide is intended for users with the Admin role in ClickHouse Cloud. ClickHouse Cloud customers may select from pre-defined system roles or create custom roles to assign to users. For more information on system roles and their associated permissions, review Console roles and permissions. This guide provides details for managing custom roles.

Create custom roles

Custom roles can contain a combination of organization, service, and database permissions. Permissions may be applied to all or a subset of services and databases.

Access organization settings and select Users and roles

From the services page, select the name of your organization. Select the Users and roles menu item from the popup menu.

Select the Roles tab

Select the Roles tab from the top middle of the screen.

Select Create new role from the upper right

Select the Create new role button in the upper right of the screen.

Name the role

Enter a descriptive role name. This will be the name you will see when assigning roles to users and API keys.

Click Allow and select permission scope

Click the Allow button and select from Organization, Service, and/or Database permissions. For a description of all permissions, see Console roles and permissions.

Ensure users who will log into the console have a minimum of Organization > Access organization permissions.

Data Sources tab accessTo access the Data Sources tab, the role currently requires the Manage and Delete Selected Services permission.

Review your new role

Review permissions assigned to your new role before finalizing. Click Create role when done.

Manage database roles (beta)

In addition to console permissions, custom roles can include data permissions that control access to the databases of selected services. This lets you manage console and database access in one place instead of maintaining separate roles in each database.

This feature is in beta and is available for services running ClickHouse version 26.4 and above.

When you add data permissions to a custom role, ClickHouse Cloud creates a matching role in each selected service, prefixed with cloud:. For example, a custom role named readonly appears in the database as cloud:readonly. Members of the custom role receive these database permissions when they connect to the service through SQL console passwordless authentication.

Roles assigned manually in the database using the sql-console-role:<email> naming convention take precedence over roles assigned through the console.

Add data permissions to a role

Create a custom role or edit an existing one. In the role dialog, click the Allow permissions button and select Data.

Select the service

Select the service the permissions apply to. Add more services to apply permissions across multiple services.

Choose the access level

Select Read-only, Admin, or Custom access. With Custom access, define specific data access permissions using ClickHouse GRANT statements.

Create the role

Click Create role. The database roles are created in the selected services.

Verify database roles

Roles managed through the console are created in the database with the cloud: prefix and the cloud storage type. To list them, query the system.roles table in the service:

SELECT * FROM system.roles;

┌─name───────────┬─id───────────────────────────────────┬─storage─┐
│ cloud:readonly │ 9a4910f4-abcf-4904-466a-717c8c75ac42 │ cloud   │
└────────────────┴──────────────────────────────────────┴─────────┘

Update custom roles

Custom roles may be updated after they’re created. Users will lose any permissions removed from the role and will gain any permissions added.

User permissions are additive. If a user has permission to perform an operation as part of multiple roles, they may not immediately lose access if permission is removed from only one role.

Access organization settings and select Users and roles
Select the Roles tab
Select the three dots next to the role you would like to update
Select Edit
Modify the permissions
Select Edit role

Delete custom roles

Custom roles may be deleted at any time.

You must have at least one user in the organization with administrative permissions. If deleting the role removes administrative permissions from the last user, you can’t delete it. To resolve this, assign at least one user the Admin system role before deleting the custom role.

Access organization settings and select Users and roles
Select the Roles tab
Select the three dots next to the role you would like to delete
Review the users and API keys that will lose access when the role is removed. Adjust assignments as needed.
Select Delete role to complete the process

​Create custom roles

​Manage database roles (beta)

​Verify database roles

​Update custom roles

​Delete custom roles

Create custom roles

Manage database roles (beta)

Verify database roles

Update custom roles

Delete custom roles