User management

Create an invitation

Creates organization invitation.

post/v1/organizations/{organizationId}/invitations

Request

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

Path parameters

organizationIdstring uuid required

ID of the organization to invite a user to.

Request body

emailstring email required

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'admin' | 'developer'

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

assignedRoleIdsstring[]

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

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.