招待を作成

組織招待を作成します。

POST /v1/organizations/{organizationId}/invitations

招待を作成

cURL

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/invitations \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]"
}
'

200

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "createdAt": "2023-11-07T05:31:56Z",
    "email": "[e-mail]",
    "expireAt": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "status": 200
}

承認

Authorization · string · header · 必須

ClickHouse Cloud console で取得した key ID と key secret を使用してください: https://clickhouse.com/docs/cloud/manage/openapi

パスパラメータ

organizationId · string<uuid> · 必須

ユーザーの招待先となる組織のID。

ボディ

application/json

email · string<email>

招待されたユーザーのメールアドレス。このメールアドレスを持つユーザーのみが招待を使用して参加できます。メールアドレスは小文字で保存されます。

role · enum<string>

組織におけるメンバーのロール。

利用可能なオプション: admin, developer

レスポンス

200

application/json

正常なレスポンス

requestId · string<uuid>

各リクエストに割り当てられる一意のID。UUIDv4

result · object

Show child attributes

status · number

HTTPステータスコード。

例:

200