Список членов организации
Возвращает список всех членов организации.
| Метод | Путь |
|---|
| GET | /v1/organizations/{organizationId}/members |
Запрос
Параметры пути
| Имя | Тип | Описание |
|---|
| organizationId | uuid | ID запрашиваемой организации. |
Ответ
Схема ответа
| Имя | Тип | Описание |
|---|
| userId | string | Уникальный ID пользователя. Если пользователь является членом нескольких организаций, этот ID останется неизменным. |
| name | string | Имя члена, установленное в личном профиле пользователя. |
| email | email | Электронная почта члена, установленная в личном профиле пользователя. |
| role | string | Роль члена в организации. |
| joinedAt | date-time | Время, когда член присоединился к организации. ISO-8601. |
Пример ответа
Получить информацию о члене
Возвращает данные о единственном члене организации.
| Метод | Путь |
|---|
| GET | /v1/organizations/{organizationId}/members/{userId} |
Запрос
Параметры пути
| Имя | Тип | Описание |
|---|
| organizationId | uuid | ID организации, частью которой является член. |
| userId | uuid | ID запрашиваемого пользователя. |
Ответ
Схема ответа
| Имя | Тип | Описание |
|---|
| userId | string | Уникальный ID пользователя. Если пользователь является членом нескольких организаций, этот ID останется неизменным. |
| name | string | Имя члена, установленное в личном профиле пользователя. |
| email | email | Электронная почта члена, установленная в личном профиле пользователя. |
| role | string | Роль члена в организации. |
| joinedAt | date-time | Время, когда член присоединился к организации. ISO-8601. |
Пример ответа
Обновить члена организации.
Обновляет роль члена организации.
| Метод | Путь |
|---|
| PATCH | /v1/organizations/{organizationId}/members/{userId} |
Запрос
Параметры пути
| Имя | Тип | Описание |
|---|
| organizationId | uuid | ID организации, частью которой является член. |
| userId | uuid | ID пользователя, которого нужно обновить. |
Параметры тела
| Имя | Тип | Описание |
|---|
| role | string | Роль члена в организации. |
Ответ
Схема ответа
| Имя | Тип | Описание |
|---|
| userId | string | Уникальный ID пользователя. Если пользователь является членом нескольких организаций, этот ID останется неизменным. |
| name | string | Имя члена, установленное в личном профиле пользователя. |
| email | email | Электронная почта члена, установленная в личном профиле пользователя. |
| role | string | Роль члена в организации. |
| joinedAt | date-time | Время, когда член присоединился к организации. ISO-8601. |
Пример ответа
Удалить члена организации
Удаляет пользователя из организации.
| Метод | Путь |
|---|
| DELETE | /v1/organizations/{organizationId}/members/{userId} |
Запрос
Параметры пути
| Имя | Тип | Описание |
|---|
| organizationId | uuid | ID запрашиваемой организации. |
| userId | uuid | ID запрашиваемого пользователя. |