Перечислите ползователей организации
Возвращает список всех пользователей в организации.
| Метод | Путь |
|---|
| 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 запрашиваемого пользователя. |