ClickHouse Cloud: Clickhouse Organization Role Patch

Change a custom ClickHouse Cloud role’s name, actors or policies.

Tool ID: clickhouse_organization_role_patch

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_organization_role_patch',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "roleId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_organization_role_patch --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "roleId": "123e4567-e89b-42d3-a456-426614174000"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": {
      "id": "id_123",
      "tenantId": "tenant_123",
      "ownerId": "owner_123"
    }
  }
}

Use deepline describe clickhouse_organization_role_patch --json for the latest machine-readable contract.

Input reference

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

Name	Type	Required	Default	Details
`payload.organizationId`	`string`	Yes	—	ID of the requested organization. Format: `uuid`.
`payload.roleId`	`string`	Yes	—	ID of the requested role. Format: `uuid`.
`payload.name`	`string`	No	—	New name for the role
`payload.actors`	`array`	No	—	New list of actor resource IDs (replaces existing actors)
`payload.policies`	`array`	No	—	New list of policies (replaces existing policies)

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.status`	`number`	No	—	HTTP status code.
`result.data.requestId`	`string`	No	—	Unique id assigned to every request. UUIDv4 Format: `uuid`.
`result.data.result`	`object`	No	—	—
`result.data.result.id`	`string`	No	—	Unique role identifier
`result.data.result.tenantId`	`string`	No	—	Tenant resource ID (e.g., organization/uuid)
`result.data.result.ownerId`	`string`	No	—	Owner resource ID (e.g., organization/uuid)
`result.data.result.name`	`string`	No	—	Name of the role
`result.data.result.type`	`"system" \| "custom"`	No	—	Whether this is a system role or a custom role Allowed: `system`, `custom`.
`result.data.result.actors`	`array`	No	—	List of actor resource IDs assigned to this role (e.g., user/uuid, apiKey/uuid)
`result.data.result.policies`	`array`	No	—	List of policies associated with this role
`result.data.result.policies[].id`	`string`	No	—	Unique policy identifier
`result.data.result.policies[].roleId`	`string`	No	—	ID of the role this policy belongs to
`result.data.result.policies[].tenantId`	`string`	No	—	Tenant resource ID (e.g., organization/uuid)
`result.data.result.policies[].allowDeny`	`"ALLOW" \| "DENY"`	No	—	Whether this policy allows or denies access Allowed: `ALLOW`, `DENY`.
`result.data.result.policies[].permissions`	`array`	No	—	List of permissions granted or denied by this policy
`result.data.result.policies[].resources`	`array`	No	—	List of resource IDs this policy applies to (e.g., instance/uuid, instance/*)
`result.data.result.policies[].tags`	`object`	No	—	—
`result.data.result.policies[].tags.grants`	`array`	No	—	Optional list of database grants (e.g., database names)
`result.data.result.policies[].tags.roleV2`	`"sql-console-readonly" \| "sql-console-admin"`	No	—	Optional SQL console role type Allowed: `sql-console-readonly`, `sql-console-admin`.
`result.data.result.createdAt`	`string`	No	—	Timestamp when the role was created. ISO-8601. Format: `date-time`.
`result.data.result.updatedAt`	`string`	No	—	Timestamp when the role was last updated. ISO-8601. Format: `date-time`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation