User
User / Users
Сущность представляет пользователя системы. Учётная запись хранится отдельно от профильной информации (имя, контакты, организационные сведения) и пользовательских настроек (язык, часовой пояс, тема, формат дат).
Сервис разделён на два endpoint-а: User — операции записи и Users — выборка коллекций и связанные справочные объекты. Собственной OData-точки чтения одной записи у User нет — список и одиночник читаются через Users.
Ключи пользователя
| Ключ | Описание |
|---|---|
| UserID | Внутренний идентификатор учётной записи |
| EmployeeID | Идентификатор сотрудника (используется при интеграциях с HR) |
| Адрес электронной почты | |
| IntegrationID | Внешний идентификатор из интегрированной системы |
Базовый URL
https://<host>/api/v01/User https://<host>/api/v01/Users
Карта endpoints
| Метод | URL | Назначение | Транспорт |
|---|---|---|---|
| GET | /api/v01/Users/odata/Users | Список учётных записей | OData |
| GET | /api/v01/Users/odata/UserProfiles | Профили пользователей | OData |
| GET | /api/v01/Users/odata/UsersSettings | Настройки пользователей | OData |
| GET | /api/v01/Users/odata/UserProfilesAccountSettings | Метаданные полей профиля | OData |
| GET | /api/v01/Users/odata/Themes | Темы оформления | OData |
| GET | /api/v01/Users/odata/DateFormats | Форматы дат | OData |
| GET | /api/v01/Users/odata/TimeFormats | Форматы времени | OData |
| GET | /api/v01/Users/odata/TimeZones | Часовые пояса | OData |
| GET | /api/v01/Users/odata/StartWeekOns | Дни начала недели | OData |
| GET | /api/v01/Users/odata/Countries | Страны | OData |
| GET | /api/v01/Users/odata/Spaces | Доступные пользователю пространства | OData |
| POST | /api/v01/User/rest/Create | Создать пользователя | REST |
| POST | /api/v01/User/rest/UpdateProfile | Обновить профиль пользователя | REST |
| POST | /api/v01/User/rest/UpdateSettings | Обновить настройки пользователя | REST |
| POST | /api/v01/User/rest/Activate | Активировать пользователя | REST |
| POST | /api/v01/User/rest/Deactivate | Деактивировать пользователя | REST |