Crear una invitación

Crea una invitación a la organización.

POST /v1/organizations/{organizationId}/invitations

Crear una invitación

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
}

Autorizaciones

Authorization · string · header · requerido

Usa el ID y el secreto de la clave obtenidos en la consola de ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi

Parámetros de ruta

organizationId · string<uuid> · requerido

ID de la organización a la que se invitará al usuario.

Cuerpo

application/json

email · string<email>

Correo electrónico del usuario invitado. Solo un usuario con este correo electrónico puede unirse mediante la invitación. El correo electrónico se almacena en minúsculas.

role · enum<string>

Rol del miembro en la organización.

Opciones disponibles: admin, developer

Respuesta

200

application/json

Respuesta exitosa

requestId · string<uuid>

ID único asignado a cada solicitud. UUIDv4

result · object

Show child attributes

status · number

Código de estado HTTP.

Ejemplo:

200