Skip to main content

Get Users

Obtains the ClickHouse users for a specific cluster

Obtain the ClickHouse users

Provide the API with a cluster slug to get all the ClickHouse users.

curl -X 'POST' \
'<your_cluster_slug>/users/' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"username": "<new_user_name>",
"password": "<new_user_password>"
# Payload response ::Dictionary
"name": "username",
"id": "2e4b1c8d-5055-02b1-8a4a-0b8b7e274b96",
"host_ip": ["::/0"],
"host_names": [],
"host_names_regexp": [],
"host_names_like": [],
"default_roles_all": True,
"default_roles_list": [],
"default_roles_except": [],
"grantees_any": True,
"grantees_list": [],
"grantees_except": []



cluster_slug  ::String

The cluster slug



name  ::String

The user name

id  ::String

The user ID on ClickHouse

host_ip  ::String

The host IP

host_names  ::Array[String]

An array containing the host names

host_names_like  ::Array[String]

An array containing what the host names should look like

default_roles_all  ::Boolean

A boolean that tells us whether the user has all the roles

default_roles_list  ::Array[String]

An array containing the default roles

default_roles_except  ::Array[String]

An array containing the default roles exceptions

guarantees_any  ::Boolean

Boolean value for the guarantees_any field

guarantees_list  ::Array[String]

The list of guarantees

guarantees_except  ::Array[String]

The list of guarantees exceptions