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: 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' 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' 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 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 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 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