Skip to main content
POST
Create an invitation
Creates organization invitation.

Авторизации

Authorization
string
header
обязательно

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Параметры пути

organizationId
string<uuid>
обязательно

ID of the organization to invite a user to.

Тело

application/json
email
string<email>

Email of the invited user. Only a user with this email can join using the invitation. The email is stored in a lowercase form.

role
enum<string>
устарело

DEPRECATED. Use assignedRoleIds instead. Role to assign to the invited user in the organization.

Доступные опции:
admin,
developer
assignedRoleIds
string[]

List of role IDs to assign to the invited user when they accept the invitation

Ответ

Successful response

status
number

HTTP status code.

Пример:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
Последнее изменение 24 июля 2026 г.