- Главная [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
- Начало работы
- Как решить вашу задачу
-
API
- Типы объектов
- Типы данных
-
Глобальные константы
- Application
- ApplicationUserProfile
- ApplicationWithBatcher
- ApplicationWithParams
- BrandingSettings
- CompanyInfo
- Converter
- Directories
- Files
- HttpApiHandler
- HttpApiRequest
- ICache
- IStorage
- MailMessage
- Mailbox
- OrganisationStructure
- OrganisationStructureTree
- Portal
- PortalPageInfo
- PortalSettings
- Portals
- Process
- Processes
- ProductionSchedule
- Reminders
- Replacements
- Serial
- ServerCollection
- Service
- SignupUrlParams
- SystemCollections
- SystemCollectionsWithEvents
- SystemCollectionsWithFilterEvents
- Templater
- Translator
- UserGroups
- Users
- Watermarks
- Report
- Reports
- SR
- Работа с приложениями
- Веб-запросы
- Права доступа
- Документооборот
- Линии
- Виджет «Код»
- Подписи
- Рабочие календари
- Интеграция с IP-телефонией
- Интеграция с сервисами рассылок
Объект пользователей
Используется для поиска по пользователям, создания новых пользователей, получения текущего пользователя и запроса восстановления пароля.
Hierarchy
Methods
addOAuth2Data
Метод добавляет способ аутентификации OAuth2 для пользователя.
const user = await System.users.search().where(f => f.email.eq('mail@example.com')).first(); const oauth2Record: OAuth2Record = {externalId: "someId", providerId: "someId"}; await System.users.addOAuth2Data(user, oauth2Record);
Parameters
user: UserItemRef
oauth2Data: TOAuth2
Returns Promise<void>
create
Метод позволяет инициализировать нового пользователя.
Для новых пользователей обязательным параметром является
email
. После заполнения данных нового пользователя его необходимо сохранить с помощью метода UserItem.save.const newUser = System.users.create(); newUser.data.email = 'mail@example.com'; await newUser.save()
Returns UserItem
createWithAuthData
Метод позволяет инициализировать нового пользователя в активном статусе с заполненными параметрами OAuth2.
Для новых пользователей обязательным параметром является email. После заполнения данных нового пользователя его необходимо сохранить с помощью метода UserItem.save.
const oauth2Record: OAuth2Record = {externalId: "someId", providerId: "someId"}; const authData: AuthData = {oauth2: [oauth2Record]}; const newUser = System.users.createWithAuthData(authData); newUser.data.email = 'mail@example.com'; await newUser.save()
Parameters
authData: AuthData
Returns UserItem
getCurrentUser
Метод позволяет получить текущего пользователя.
const currentUser = await System.users.getCurrentUser();
Returns Promise<CurrentUserItem>
removeOAuth2Data
Метод удаляет способ аутентификации OAuth2 у пользователя.
const user = await System.users.search().where(f => f.email.eq('mail@example.com')).first(); const oauth2Record: OAuth2Record = {externalId: "someId", providerId: "someId"}; await System.users.removeOAuth2Data(user, oauth2Record);
Parameters
user: UserItemRef
oauth2Data: TOAuth2
Returns Promise<void>
requestPasswordRecovery
Метод генерирует новую ссылку на восстановление пароля пользователя
и отправляет эту ссылку на email, переданный в качестве параметра.
Parameters
email: string
Returns Promise<void>
search
Метод позволяет выполнить поиск пользователей.
Для выборки элементов коллекций используется объект Search:
const users = await System.users.search() .where(f => f.email.eq("email@example.com")) .all();
Пример поиска по статусу пользователя:
const users = await System.users.search() .where(u => u.__status.eq(UserStatus.Blocked)) .all();
Подробнее об использовании объекта поиска можно узнать в статье «Работа с приложениями».
Returns UserSearch
Methods