Alpha.Community

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

Функции

RequestAppList

void RequestAppList()

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

Функция не требует входных параметров.

Просмотр списка приложений доступен только пользователям с правами администратора.

Вызов: SecurityManager.RequestAppList()

Результат:

  • в случае успешного завершения операции активируется событие RequestAppListComplete;
  • в случае неуспешного завершения операции активируется событие RequestAppListFailed.

RequestGroupList

void RequestGroupList()

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

Функция не требует входных параметров.

Просмотр списка групп пользователей доступен только пользователям с правами администратора.

Вызов: SecurityManager.RequestGroupList()

Результат:

  • в случае успешного завершения операции активируется событие RequestGroupListComplete;
  • в случае неуспешного завершения операции активируется событие RequestGroupListFailed.

RequestUsersList

void RequestUsersList()

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

Функция не требует входных параметров.

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

Вызов: SecurityManager.RequestUsersList()

Результат:

  • в случае успешного завершения операции активируется событие RequestUsersListComplete;
  • в случае неуспешного завершения операции активируется событие RequestUsersListFailed.

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

RequestWorkstationsList

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

RequestClusterWorkplacesList

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

DeleteApplication

void DeleteApplication(string appName)

Удаляет приложение из подсистемы безопасности.

Входной параметр – имя приложения (тип значения – string).

Удаление приложений доступно только пользователям с правами администратора.

Вызов: SecurityManager.DeleteApplication("Управление состоянием оборудования")

Результат:

  • в случае успешного завершения операции активируется событие DeleteApplicationComplete;
  • в случае неуспешного завершения операции активируется событие DeleteApplicationFailed.

DeleteGroup

void DeleteGroup(string groupUID)

Удаляет группу пользователей из подсистемы безопасности.

Входной параметр – уникальный идентификатор (uid) группы вида alpha:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (тип значения – string).

Удаление групп пользователей доступно только пользователям с правами администратора.

Вызов: SecurityManager.DeleteGroup("alpha:d01969e0-ae05-4548-9375-2533b326a588")

Результат:

  • в случае успешного завершения операции активируется событие DeleteGroupComplete;
  • в случае неуспешного завершения операции активируется событие DeleteGroupFailed.

DeleteUser

void DeleteUser(string userUID)

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

Входной параметр – уникальный идентификатор (uid) учетной записи вида alpha:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (тип значения – string).

Удаление учетных записей доступно только пользователям с правами администратора.

Вызов: SecurityManager.DeleteUser("alpha:d01969e0-ae05-4548-9375-2533b326a588")

Результат:

  • в случае успешного завершения операции активируется событие DeleteUserComplete;
  • в случае неуспешного завершения операции активируется событие DeleteUserFailed.

DeleteWorkstation

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

DeleteClusterWorkplace

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

GetErrorDescriptionByCode

string GetErrorDescriptionByCode(uint1 FailReason)

Возвращает текстовое описание ошибок, возникающих при запросе и удалении приложений, групп пользователей и учетных записей.

Входной параметр – переменная FailReason (тип значения – uint1).

ExportConfiguration

void ExportConfiguration(string fullPath)

Создает (или перезаписывает) файл резервной копии текущей конфигурации Alpha.Security в указанном месте.

Входной параметр – полный путь к создаваемому файлу вместе с именем файла (тип значения – string).

Вызов: SecurityManager.ExportConfiguration("D:/export.ldb")

Результат:

  • в случае успешного завершения операции активируется событие GetConfigurationFinished;
  • в случае неуспешного завершения операции активируется событие GetConfigurationFailed.

ImportConfiguration

void ImportConfiguration(string fullPath)

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

Входной параметр – полный путь к файлу резервной копии вместе с именем файла (тип значения – string).

Вызов: SecurityManager.ImportConfiguration("D:/export.ldb")

Результат:

  • в случае успешного завершения операции активируется событие SetConfigurationFinished;
  • в случае неуспешного завершения операции активируется событие SetConfigurationFailed.

RequestListOSUsersJSON

void RequestListOSUsersJSON()

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

Функция не требует входных параметров.

Вызов: SecurityManager.RequestListOSUsersJSON()

Результат:

  • в случае успешного завершения операции активируется событие RequestListOSUsersJSONComplete;
  • в случае неуспешного завершения операции активируется событие RequestListOSUsersJSONFailed.

SetConfigureServer

void SetConfigureServer(string ldapHost, uint4 ldapPort, bool secure, string ldapUser, string ldapPassword, string rootDn)

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

Входные параметры:

  • IP-адрес LDAP-сервера;
  • порт;
  • параметр защищенного соединения с LDAP-сервером (true – использовать защищенное соединение, false – не использовать);
  • учетная запись администратора (должна быть указана в виде, принятом для LDAP: cn="логин-администратора",dc="домен-базы-данных");
  • пароль учетной записи администратора (можно указать в открытом виде, значение будет зашифровано при передаче на LDAP-сервер);
  • название LDAP-каталога (должен быть указан в виде, принятом для LDAP: ou="название-каталога",dc="домен-базы-данных").

Вызов: SecurityManager.SetConfigureServer("127.0.0.1",389,false,
"cn=Manager,dc=maxcrc,dc=com","secret","ou=Security,dc=maxcrc,dc=com");

Результат:

  • в случае успешного завершения операции активируется событие LDAPServerChanged;
  • в случае неуспешного завершения операции активируется событие LDAPServerChangeFailure.

ResetConfigureServer

void ResetConfigureServer()

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

Вызов: SecurityManager.ResetConfigureServer()

GetExternalUserList

uint4 GetExternalUserList(string sourceID, string login, string password, string domainNameOrRootDn)

Запрашивает список учетных записей из внешнего источника аутентификации, указанного в настройках агента безопасности (в файле alpha.security.agent.xml).

Входные параметры:

  • уникальный идентификатор внешнего источника (как в файле alpha.security.agent.xml, элемент <Source>, атрибут SourceID);
  • логин пользователя, имеющего доступ к администрированию этого источника;
  • пароль пользователя, имеющего доступ к администрированию этого источника;
  • имя источника.

Возвращает идентификатор запроса, по которому можно сопоставить запрос и ответ.

Вызов: SecurityManager.GetExternalUserList("Source1","admin","secret","domain");

В случае успешного завершения операции активируется событие GetExternalUserListFinished.