Список всех приглашений
Возвращает список всех приглашений в организацию.
| Метод | Путь |
|---|
| GET | /v1/organizations/{organizationId}/invitations |
Запрос
Параметры пути
| Имя | Тип | Описание |
|---|
| organizationId | uuid | ID запрашиваемой организации. |
Ответ
Схема ответа
| Имя | Тип | Описание |
|---|
| role | string | Роль участника в организации. |
| id | uuid | Уникальный ID приглашения. |
| email | email | Email пригласительного пользователя. Только пользователь с этим адресом электронной почты может присоединиться, используя приглашение. Email хранится в нижнем регистре. |
| createdAt | date-time | Временная метка создания приглашения. ISO-8601. |
| expireAt | date-time | Временная метка истечения приглашения. ISO-8601. |
Пример ответа
Создать приглашение
Создает приглашение в организацию.
| Метод | Путь |
|---|
| POST | /v1/organizations/{organizationId}/invitations |
Запрос
Параметры пути
| Имя | Тип | Описание |
|---|
| organizationId | uuid | ID организации, в которую приглашается пользователь. |
Параметры тела
| Имя | Тип | Описание |
|---|
| email | string | Email пригласительного пользователя. Только пользователь с этим адресом электронной почты может присоединиться, используя приглашение. Email хранится в нижнем регистре. |
| role | string | Роль участника в организации. |
Ответ
Схема ответа
| Имя | Тип | Описание |
|---|
| role | string | Роль участника в организации. |
| id | uuid | Уникальный ID приглашения. |
| email | email | Email пригласительного пользователя. Только пользователь с этим адресом электронной почты может присоединиться, используя приглашение. Email хранится в нижнем регистре. |
| createdAt | date-time | Временная метка создания приглашения. ISO-8601. |
| expireAt | date-time | Временная метка истечения приглашения. ISO-8601. |
Пример ответа
Получить детали приглашения
Возвращает детали для одного приглашения в организацию.
| Метод | Путь |
|---|
| GET | /v1/organizations/{organizationId}/invitations/{invitationId} |
Запрос
Параметры пути
| Имя | Тип | Описание |
|---|
| organizationId | uuid | ID запрашиваемой организации. |
| invitationId | uuid | ID запрашиваемого приглашения. |
Ответ
Схема ответа
| Имя | Тип | Описание |
|---|
| role | string | Роль участника в организации. |
| id | uuid | Уникальный ID приглашения. |
| email | email | Email пригласительного пользователя. Только пользователь с этим адресом электронной почты может присоединиться, используя приглашение. Email хранится в нижнем регистре. |
| createdAt | date-time | Временная метка создания приглашения. ISO-8601. |
| expireAt | date-time | Временная метка истечения приглашения. ISO-8601. |
Пример ответа
Удалить приглашение в организацию
Удаляет одно приглашение в организацию.
| Метод | Путь |
|---|
| DELETE | /v1/organizations/{organizationId}/invitations/{invitationId} |
Запрос
Параметры пути
| Имя | Тип | Описание |
|---|
| organizationId | uuid | ID организации, в которой есть приглашение. |
| invitationId | uuid | ID запрашиваемого приглашения. |