Role Management

Update a role

Updates an existing custom role. System roles cannot be updated. All fields are optional - only provided fields will be updated.

patch/v1/organizations/{organizationId}/roles/{roleId}

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/roles/{roleId}
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the requested organization.

roleIdstring uuid required

ID of the requested role.

Request body

namestring

New name for the role

actorsstring[]

New list of actor resource IDs (replaces existing actors)

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.