Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

События

RequestAppListComplete

Получен список приложений, имеющихся в подсистеме безопасности Alpha.Security.

Активируется в случае успешного завершения операции RequestAppList().

Возвращает данные в JSON-формате в переменную JSONAppList.

Результат запроса списка приложений в JSON-формате:

{
 "data":[
  {
  "applicationName": "Управление состоянием оборудования",
  "applicationType": "CustomApp"
  },
  {
   "applicationName": "Alpha.Security",
   "applicationType": "SystemApp"
  }
 ]
}

В данном примере:

  • приложение Управление состоянием оборудования создано пользователем с правами администратора, о чем говорит тип приложения CustomApp;
  • приложение Alpha.Security – системное приложение, в котором определены системные права.

RequestGroupListComplete

Получен список групп пользователей, имеющихся в подсистеме безопасности Alpha.Security.

Активируется в случае успешного завершения операции RequestGroupList().

Возвращает данные в JSON-формате в переменную JSONGroupList.

Результат запроса списка групп в JSON-формате:

{
 "data":[
  {
  "description": " ",
  "displayName": "Диспетчеры",
  "uid": "alpha:d01969e0-ae05-4548-9375-2533b326a588"
  },
  {
   "description": " ",
   "displayName": "Операторы",
   "uid": "alpha:de893741-9258-45b2-a61a-e79fd87ae10c"
  }
 ]
}

Уникальный идентификатор (uid) формируется подсистемой безопасности в момент создания приложения.

RequestUsersListComplete

Получен список пользователей, имеющихся в подсистеме безопасности Alpha.Security.

Активируется в случае успешного завершения операции RequestUsersList().

Возвращает данные в JSON-формате в переменную JSONUsersList.

Результат запроса списка пользователей в JSON-формате:

{
 "data": [
  {
   "uid": "alpha:1161a849-8849-43de-9ba0-e57c7045acbf",
   "employeeType": "",
   "departmentNumber": "123",
   "mail": "[email protected]",
   "telephoneNumber": "123456",
   "description": "",
   "givenName": "Петр",
   "initials": "Петрович",
   "sn": "Петров",
   "displayName": "Петров Петр Петрович",
   "symbolicId": "petrov",
   "groups": [
    "Операторы"
   ],
   "roles": ""
  },
  {
   "uid": "alpha:8d330867-fe85-4b07-89fa-2a995736ac42",
   "employeeType": "",
   "departmentNumber": "123",
   "mail": "[email protected]",
   "telephoneNumber": "456789",
   "description": "",
   "givenName": "Иван",
   "initials": "Иванович",
   "sn": "Иванов",
   "displayName": "Иванов Иван",
   "symbolicId": "ivanov",
   "groups": [
    "Диспетчеры"
   ],
   "roles": ""
  }
 ]
}

Уникальный идентификатор (uid) формируется подсистемой безопасности в момент создания учетной записи.

Применение события подробнее описано в Собственный конфигуратор подсистемы безопасности.

RequestWorkstationsListComplete

В разработке.

RequestClusterWorkplacesListComplete

В разработке.

RequestAppListFailed

Ошибка при получении списка приложений подсистемы безопасности Alpha.Security.

Активируется в случае неуспешного завершения операции RequestAppList().

Возвращает номер ошибки в переменную FailReason, тип значения – uint1.

Получить текст ошибки можно, вызвав функцию GetErrorDescriptionByCode().

RequestGroupListFailed

Ошибка при получении списка групп пользователей подсистемы безопасности Alpha.Security.

Активируется в случае неуспешного завершения операции RequestGroupList().

Возвращает номер ошибки в переменную FailReason, тип значения – uint1.

Получить текст ошибки можно, вызвав функцию GetErrorDescriptionByCode().

RequestUsersListFailed

Ошибка при получении списка пользователей подсистемы безопасности Alpha.Security.

Активируется в случае неуспешного завершения операции RequestUsersList().

Возвращает номер ошибки в переменную FailReason, тип значения – uint1.

Получить текст ошибки можно, вызвав функцию GetErrorDescriptionByCode().

RequestWorkstationsListFailed

В разработке.

RequestClusterWorkplacesListFailed

В разработке.

DeleteApplicationComplete

Приложение удалено из подсистемы безопасности Alpha.Security.

Активируется в случае успешного завершения операции DeleteApplication().

DeleteGroupComplete

Группа пользователей удалена из подсистемы безопасности Alpha.Security.

Активируется в случае успешного завершения операции DeleteGroup().

DeleteUserComplete

Учетная запись удалена из подсистемы безопасности Alpha.Security.

Активируется в случае успешного завершения операции DeleteUser().

DeleteWorkstationComplete

В разработке.

DeleteClusterWorkplaceComplete

В разработке.

DeleteApplicationFailed

Ошибка при удалении приложения из подсистемы безопасности Alpha.Security.

Активируется в случае неуспешного завершения операции DeleteApplication().

Возвращает номер ошибки в переменную FailReason, тип значения – uint1.

Получить текст ошибки можно, вызвав функцию GetErrorDescriptionByCode().

DeleteGroupFailed

Ошибка при удалении группы пользователей из подсистемы безопасности Alpha.Security.

Активируется в случае неуспешного завершения операции DeleteGroup().

Возвращает номер ошибки в переменную FailReason, тип значения – uint1.

Получить текст ошибки можно, вызвав функцию GetErrorDescriptionByCode().

DeleteUserFailed

Ошибка при удалении учетной записи из подсистемы безопасности Alpha.Security.

Активируется в случае неуспешного завершения операции DeleteUser().

Возвращает номер ошибки в переменную FailReason, тип значения – uint1.

Получить текст ошибки можно, вызвав функцию GetErrorDescriptionByCode().

DeleteWorkstationFailed

В разработке.

DeleteClusterWorkplaceFailed

В разработке.

GetConfigurationFinished

Файл резервной копии конфигурации Alpha.Security создан (или перезаписан) успешно.

Активируется в случае успешного завершения операции ExportConfiguration.

GetConfigurationFailed

Ошибка при создании (или перезаписи) файла резервной копии конфигурации Alpha.Security.

Активируется в случае неуспешного завершения операции ExportConfiguration.

Возвращает код ошибки в переменную FailReason, тип значения – uint1. Если код ошибки равен:

  • 2 – не удалось экспортировать конфигурацию из LDAP (например, не существует корневого каталога и т.д.);
  • 3 – нет права на чтение конфигурации;
  • 4 – не удалось открыть файл для записи конфигурации.

SetConfigurationFinished

Резервная копия конфигурации Alpha.Security восстановлена успешно.

Активируется в случае успешного завершения операции ImportConfiguration.

SetConfigurationFailed

Не удалось восстановить резервную копию конфигурации Alpha.Security.

Активируется в случае неуспешного завершения операции ImportConfiguration.

Возвращает код ошибки в переменную FailReason, тип значения – uint1. Если код ошибки равен:

  • 1 – файл резервной копии поврежден;
  • 2 – не удалось зачистить базу данных LDAP перед применением конфигурации;
  • 3 – произошла внутренняя ошибка LDAP;
  • 4 – произошла непредвиденная ошибка на стороне агента;
  • 5 – у пользователя нет права на редактирование конфигурации;
  • 6 – другие ошибки;
  • 7 – не удается открыть файл с конфигурацией.

LastActionError

Ошибка выполнения последнего действия.

Активируется в результате внесения в конфигурацию подсистемы безопасности таких изменений, которые могут привести к нарушению работы Alpha.Security. Таким действием является, например, удаление учетной записи единственного администратора.

Возвращает текст ошибки в переменную ErrorMessage, тип значения – string.

RequestListOSUsersJSONComplete

Получен список учетных записей операционной системы.

Активируется в случае успешного завершения операции RequestListOSUsersJSON.

Возвращает данные в JSON-формате в переменную OSUsersListJSON, тип значения – string.

Результат запроса списка учетных записей в JSON-формате:

{
 "users": [
  {
   "login": "Администратор",
   "id": "win@123456789",
   "midname": "",
   "lastname": "",
   "description": "Встроенная учетная запись администратора компьютера",
   "displayname": "",
   "email": "",
   "position": ""
  },
  {
   "login": "Гость",
   "id": "win@987654321",
   "midname": "",
   "lastname": "",
   "description": "Встроенная учетная запись для доступа гостей к компьютеру или домену",
   "displayname": "",
   "email": "",
   "position": ""
  }
 ]
}

RequestListOSUsersJSONFailed

Ошибка при получении списка учетных записей операционной системы.

Активируется в случае неуспешного завершения операции RequestListOSUsersJSON.

Возвращает номер ошибки в переменную FailReason, тип значения – uint1.

Получить текст ошибки можно, вызвав функцию GetErrorDescriptionByCode().

LDAPServerChanged

Выполнено подключение к указанному каталогу на указанном LDAP-сервере.

Активируется в случае успешного завершения операции SetConfigureServer.

LDAPServerChangeFailure

Не удалось выполнить подключение к указанному каталогу на указанном LDAP-сервере.

Активируется в случае неуспешного завершения операции SetConfigureServer.

Возвращает текст ошибки в переменную errorMessage, тип значения – string.

GetExternalUserListFinished

Получен список учетных записей из внешнего источника.

Активируется в случае успешного завершения операции GetExternalUserList.

Переменные:

  • resultId – содержит идентификатор запроса, по которому получен ответ;
  • resultCode – содержит код результата запроса, возможные значения:
    • 0 – успешно;
    • 1 – с ошибками;
    • 2 – неуспешно.
  • resultDescription – содержит описание результата запроса в виде json-строки;
  • resultData – результат запроса в виде json-строки.

LdapUserChanged

Активируется в случае смены пользователя, через которого выполняется доступ к конфигурированию безопасности, указанного в настройках агента безопасности в качестве пользователя по умолчанию.

Также активируется при запуске проекта в рантайм (даже если смены пользователя не было).

Возвращает данные пользователя в JSON-формате в переменную userInfo, вид значения:

{
 "login":"<value>",
 "id":"<value>",
 "displayName":"<value>",
}