Create an invitation | ClickHouse Docs

POST/v1/organizations/{organizationId}/invitations

Creates organization invitation.

Authorizations

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

Path parameters

organizationIdstringrequired
ID of the organization to invite a user to.

format: uuid

Request bodyJSON

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

format: email
roledeprecatedadminordeveloper
DEPRECATED. Use assignedRoleIds instead. Role to assign to the invited user in the organization.
assignedRoleIdsoptionalarray ofstring
List of role IDs to assign to the invited user when they accept the invitation

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalobject
6 properties
- roledeprecatedadminordeveloper
  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.
- idoptionalstring
  Unique invitation ID.
  
  format: uuid
- emailoptionalstring
  Email of the invited user. Only a user with this email can join using the invitation. The email is stored in a lowercase form.
  
  format: email
- createdAtoptionalstring
  Invitation creation timestamp. ISO-8601.
  
  format: date-time
- expireAtoptionalstring
  Timestamp the invitation expires. ISO-8601.
  
  format: date-time
- assignedRolesoptionalarray ofobject
  Custom roles and System roles that will be assigned to the user when they accept the invitation
  
  3 properties
  roleIdoptionalstring
  Unique identifier of the role
  
  format: uuid
  roleNameoptionalstring
  Human-readable name of the role
  
  roleTypeoptionalsystemorcustom
  Type of role: system (predefined) or custom (organization-defined)

Create an invitation

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/invitations \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "role": "admin",
  "assignedRoleIds": [
    "string"
  ]
}
'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/invitations';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Basic <token>'},
  body: JSON.stringify({email: 'user@example.com', role: 'admin', assignedRoleIds: ['string']})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/invitations"

payload = {
    "email": "user@example.com",
    "role": "admin",
    "assignedRoleIds": ["string"]
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "role": "admin",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "email": "user@example.com",
    "createdAt": "2019-08-24T14:15:22Z",
    "expireAt": "2019-08-24T14:15:22Z",
    "assignedRoles": [
      {
        "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
        "roleName": "string",
        "roleType": "system"
      }
    ]
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}