Skip to main content

Update User

Updates a ClickHouse user in a specific cluster.

Update a ClickHouse user

Provide the API with a cluster slug a name and a password to update a user in that cluster.

curl -X 'PATCH' \
'https://api.gigapipe.com/v1/clusters/<your_cluster_slug>/users/' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"rename": {
"username": "old-username",
"to": "new-username"
},
"change_password": {
"username": "username",
"password": "new-password"
}
}'
# Payload response ::Dictionary
{
"message": "User <username> updated."
}

Parameters

Attributes


cluster_slug  ::String

The cluster slug


Payload

Attributes


rename  ::Dictionary

The old username and the new one

username  ::String

The old username

to  ::String

The new username


change_password  ::Dictionary

The username and the new password

username  ::String

The username of the user

password  ::String

The new password


Response

Attributes


message  ::String

A basic message response