Управление пользователями
Получение пользователя по идентификатору
Возвращает информацию о пользователе по его идентификатору.
Запрос
Swagger
GET
/v2/user/{userId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | ||
id | string | uuid | |
name | string | ||
creationDate | string | date-time | |
sub | string | ||
lastUpdateDate | string | date-time | |
notificationTypes | string[] |
Перезапись пользователя
Перезаписывает пользователя.
Запрос
Swagger
PUT
/v2/user/{userId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
name | string | Имя пользователя |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | ||
id | string | uuid | |
name | string | ||
creationDate | string | date-time | |
sub | string | ||
lastUpdateDate | string | date-time | |
notificationTypes | string[] |
Удаление пользователя и его настроек
Удаляет пользователя и его настройки.
Запрос
Swagger
DELETE
/v2/user/{userId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
* - обязательный параметр
Ответ
string
Получение пользователей
Возвращает список пользователей.
Запрос
Swagger
GET
/v2/userПараметры
| Параметр | Тип | Описание |
|---|---|---|
name.contains (query) | string | |
notificationTypes (query) | array | |
sub (query) | string | |
pageNumber (query) | integer | |
pageSize (query) | integer | |
sortBy (query) | string | |
order (query) | string |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | UserDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Создание пользователя
Создает пользователя.
Запрос
Swagger
POST
/v2/userТело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
id | string | uuid | Идентификатор из мастер-системы |
name | string | Имя пользователя |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | ||
id | string | uuid | |
name | string | ||
creationDate | string | date-time | |
sub | string | ||
lastUpdateDate | string | date-time | |
notificationTypes | string[] |
Отмена удаления пользователя и его настроек
Отменяет удаление пользователя и его настроек.
Запрос
Swagger
POST
/v2/user/{userId}/cancel-deletionПараметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
* - обязательный параметр
Ответ
string
Создание пользователя по JWT-токену
Создает пользователя по JWT-токену.
Запрос
Swagger
POST
/v2/user/infoОтвет
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | ||
id | string | uuid | |
name | string | ||
creationDate | string | date-time | |
sub | string | ||
lastUpdateDate | string | date-time | |
profiles | ProfileWithSettingsResponseDto[] | Профили |
Создание нового пользователя с профилями и настройками
Создает пользователя с профилями и настройками.
Запрос
Swagger
POST
/v2/user-profiles-settingsТело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
id | string | uuid | Идентификатор пользователя |
name | string | Имя пользователя | |
profiles | ProfileWithSettingsRequestDto[] | Профили |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | ||
id | string | uuid | |
name | string | ||
creationDate | string | date-time | |
sub | string | ||
lastUpdateDate | string | date-time | |
profiles | ProfileWithSettingsResponseDto[] | Профили |
Удаление пользователей и их настроек
Удаляет пользователей и их настройки.
Запрос
Swagger
DELETE
/v2/usersПараметры
| Параметр | Тип | Описание |
|---|---|---|
userUUIDs (query) | array | Идентификаторы пользователей |
Модели
UserDto
ResponseError
UserPutRequestDto
PageResponseUserDto
UserPostRequestDto
SettingsResponseDto
ProfileWithSettingsResponseDto
UserAllInfoResponseAfterPostDto
SettingsRequestDto
ProfileWithSettingsRequestDto
UserAllInOnePostRequestDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки