ClickHouse User management API

The User management API from ClickHouse — 4 operation(s) for user management.

Documentation GitHub OpenAPI

Business capability

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/organizations/{organizationId}/members List organization members · List organization members #

Ask an LLM

“Who are the members of my ClickHouse Cloud organization?”

“Which people currently have access to our org?”

Tell an agent

List all members of organization {org}.

Show everyone who belongs to org {org} and their roles.

GET /v1/organizations/{organizationId}/members/{userId} Get one member's details · Get member details #

Ask an LLM

“What role does a specific member have in our organization?”

“Which custom roles are assigned to one particular user?”

Tell an agent

Show member {userId} in organization {org}.

Get the role assigned to user {userId} in org {org}.

PATCH /v1/organizations/{organizationId}/members/{userId} Change a member's role · Update organization member #

Ask an LLM

“How do I promote a member to admin?”

“Can I assign custom roles to an existing member?”

Tell an agent

Change member {userId}'s role in org {org} to {role}.

Assign role IDs {assignedRoleIds} to existing member {userId} in organization {org}.

DELETE /v1/organizations/{organizationId}/members/{userId} Remove a member from the organization · Remove an organization member #

Ask an LLM

“How do I remove someone who left the company from our organization?”

“Can I revoke a user's membership in the org?”

Tell an agent destructive · confirm first

Remove user {userId} from organization {org}.

Revoke member {userId}'s access to org {org}.

GET /v1/organizations/{organizationId}/invitations List pending organization invitations · List all invitations #

Ask an LLM

“Which invitations to our organization are still outstanding?”

“Who have we invited to the org that hasn't joined yet?”

Tell an agent

List all invitations for organization {org}.

Show outstanding invites in org {org}.

POST /v1/organizations/{organizationId}/invitations Invite someone to the organization · Create an invitation #

Ask an LLM

“How do I invite a teammate to our ClickHouse Cloud org by email?”

“Can I pick the role a new invitee will get when they join?”

Tell an agent

Invite {email} to organization {org}.

Send an invitation to {email} for org {org} with role {role}.

GET /v1/organizations/{organizationId}/invitations/{invitationId} Get one invitation's details · Get invitation details #

Ask an LLM

“What email and role is a specific invitation for?”

“Which role will a particular pending invite grant?”

Tell an agent

Show invitation {invitationId} in organization {org}.

Get details of invite {invitationId} for org {org}.

DELETE /v1/organizations/{organizationId}/invitations/{invitationId} Cancel an organization invitation · Delete organization invitation #

Ask an LLM

“How do I cancel an invite I sent to the wrong email address?”

“Can I withdraw a pending invitation before it's accepted?”

Tell an agent destructive · confirm first

Delete invitation {invitationId} from organization {org}.

Withdraw pending invite {invitationId} in org {org}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/clickhouse:clickhouse-user-management-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: OpenAPI spec for ClickHouse Cloud User management API
  version: '1.0'
  contact:
    name: ClickHouse Support
    url: https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1107336
    email: support@clickhouse.com
servers:
- url: https://api.clickhouse.cloud
security:
- basicAuth: []
tags:
- name: User Management
paths:
  /v1/organizations/{organizationId}/members:
    get:
      summary: List organization members
      description: Returns a list of all members in the organization.
      operationId: memberGetList
      parameters:
      - in: path
        name: organizationId
        description: ID of the requested organization.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 200
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/Member'
        '400':
          description: The request cannot be processed due to a client error. Please verify your request parameters and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 400
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '500':
          description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 500
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
      tags:
      - User Management
  /v1/organizations/{organizationId}/members/{userId}:
    get:
      summary: Get member details
      description: Returns a single organization member details.
      operationId: memberGet
      parameters:
      - in: path
        name: organizationId
        description: ID of the organization the member is part of.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: userId
        description: ID of the requested user.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 200
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
                  result:
                    $ref: '#/components/schemas/Member'
        '400':
          description: The request cannot be processed due to a client error. Please verify your request parameters and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 400
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '500':
          description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 500
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
      tags:
      - User Management
    patch:
      summary: Update organization member
      description: Updates organization member role.
      operationId: memberUpdate
      parameters:
      - in: path
        name: organizationId
        description: ID of the organization the member is part of.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: userId
        description: ID of the user to patch
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemberPatchRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 200
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
                  result:
                    $ref: '#/components/schemas/Member'
        '400':
          description: The request cannot be processed due to a client error. Please verify your request parameters and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 400
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '500':
          description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 500
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
      tags:
      - User Management
    delete:
      summary: Remove an organization member
      description: Removes a user from the organization
      operationId: memberDelete
      parameters:
      - in: path
        name: organizationId
        description: ID of the requested organization.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: userId
        description: ID of the requested user.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 200
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '400':
          description: The request cannot be processed due to a client error. Please verify your request parameters and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 400
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '500':
          description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 500
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
      tags:
      - User Management
  /v1/organizations/{organizationId}/invitations:
    get:
      summary: List all invitations
      description: Returns list of all organization invitations.
      operationId: invitationGetList
      parameters:
      - in: path
        name: organizationId
        description: ID of the requested organization.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 200
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/Invitation'
        '400':
          description: The request cannot be processed due to a client error. Please verify your request parameters and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 400
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '500':
          description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 500
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
      tags:
      - User Management
    post:
      summary: Create an invitation
      description: Creates organization invitation.
      operationId: invitationCreate
      parameters:
      - in: path
        name: organizationId
        description: ID of the organization to invite a user to.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvitationPostRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 200
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
                  result:
                    $ref: '#/components/schemas/Invitation'
        '400':
          description: The request cannot be processed due to a client error. Please verify your request parameters and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 400
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '500':
          description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 500
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
      tags:
      - User Management
  /v1/organizations/{organizationId}/invitations/{invitationId}:
    get:
      summary: Get invitation details
      description: Returns details for a single organization invitation.
      operationId: invitationGet
      parameters:
      - in: path
        name: organizationId
        description: ID of the requested organization.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: invitationId
        description: ID of the requested organization.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 200
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
                  result:
                    $ref: '#/components/schemas/Invitation'
        '400':
          description: The request cannot be processed due to a client error. Please verify your request parameters and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 400
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '500':
          description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 500
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
      tags:
      - User Management
    delete:
      summary: Delete organization invitation
      description: Deletes a single organization invitation.
      operationId: invitationDelete
      parameters:
      - in: path
        name: organizationId
        description: ID of the organization that has the invitation.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: invitationId
        description: ID of the requested organization.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 200
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '400':
          description: The request cannot be processed due to a client error. Please verify your request parameters and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 400
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '500':
          description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 500
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
      tags:
      - User Management
components:
  schemas:
    InvitationPostRequest:
      properties:
        email:
          description: Email of the invited user. Only a user with this email can join using the invitation. The email is stored in a lowercase form.
          type: string
          format: email
        role:
          description: DEPRECATED. Use `assignedRoleIds` instead. Role to assign to the invited user in the organization.
          type: string
          enum:
          - admin
          - developer
          deprecated: true
        assignedRoleIds:
          type: array
          description: List of role IDs to assign to the invited user when they accept the invitation
          items:
            type: string
    Invitation:
      properties:
        role:
          description: DEPRECATED. Use `assignedRoles` instead. Role of the invited user in the organization. For organizations that have migrated to custom roles, this field is frozen at the pre-migration value and does not reflect the role assignment that will be applied.
          type: string
          enum:
          - admin
          - developer
          deprecated: true
        id:
          description: Unique invitation ID.
          type: string
          format: uuid
        email:
          description: Email of the invited user. Only a user with this email can join using the invitation. The email is stored in a lowercase form.
          type: string
          format: email
        createdAt:
          description: Invitation creation timestamp. ISO-8601.
          type: string
          format: date-time
        expireAt:
          description: Timestamp the invitation expires. ISO-8601.
          type: string
          format: date-time
        assignedRoles:
          type: array
          description: Custom roles and System roles that will be assigned to the user when they accept the invitation
          items:
            $ref: '#/components/schemas/AssignedRole'
    AssignedRole:
      properties:
        roleId:
          description: Unique identifier of the role
          type: string
          format: uuid
        roleName:
          description: Human-readable name of the role
          type: string
        roleType:
          description: 'Type of role: system (predefined) or custom (organization-defined)'
          type: string
          enum:
          - system
          - custom
    MemberPatchRequest:
      properties:
        role:
          description: DEPRECATED. Use `assignedRoleIds` instead. Role of the member in the organization.
          type: string
          enum:
          - admin
          - developer
          deprecated: true
        assignedRoleIds:
          type: array
          description: List of role IDs to assign to the member
          items:
            type: string
    Member:
      properties:
        userId:
          description: Unique user ID. If a user is a member in multiple organizations this ID will stay the same.
          type: string
        name:
          description: Name of the member as set a personal user profile.
          type: string
        email:
          description: Email of the member as set in personal user profile.
          type: string
          format: email
        role:
          description: DEPRECATED. Use `assignedRoles` instead. Role of the member in the organization. For organizations that have migrated to custom roles, this field is frozen at the pre-migration value and does not reflect current role assignments.
          type: string
          enum:
          - admin
          - developer
          deprecated: true
        joinedAt:
          description: Timestamp the member joined the organization. ISO-8601.
          type: string
          format: date-time
        assignedRoles:
          type: array
          description: Custom roles and System roles assigned to this member
          items:
            $ref: '#/components/schemas/AssignedRole'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi'
x-tagGroups:
- name: Organization
  tags:
  - Organization
  - Billing
  - User management
  - Role Management
  - UDF
- name: Service
  tags:
  - Service
  - Backup
- name: API keys
  tags:
  - API keys
- name: Prometheus
  tags:
  - Prometheus
- name: ClickPipes
  tags:
  - ClickPipes
- name: ClickStack
  tags:
  - ClickStack
- name: Postgres
  tags:
  - Postgres

ClickHouse User management API

Operations 8

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification