Alpha.Community

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

Функции

Load

void Load(string userUID)

Загружает информацию об учетной записи из подсистемы безопасности в элемент.

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

Вызов: SecurityManagerUser.Load("alpha:ab5cc552-a515-48ab-9e82-436aabf6bdfc")

Результат:

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

Save

void Save()

Отправляет информацию об учетной записи в подсистему безопасности после:

  • редактирования ранее выгруженной из подсистемы безопасности учетной записи;
  • создания учетной записи из проекта Alpha.HMI с помощью функции New() и свойств элемента.

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

При вызове функции выполняется автоматическая проверка уникальности указанного логина.

Вызов: SecurityManagerUser.Save()

Результат:

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

SetId

void SetId(id string)

Задает id для учетной записи, загруженной в элемент.

Входной параметр – идентификатор в виде строки.

Идентификатор формируется подсистемой безопасности автоматически в момент создания учетной записи. Эту функцию можно использовать для указания собственного идентификатора при создании новой учетной записи.

SetPassword

uint2 SetPassword(string password)

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

Входной параметр – пароль в виде строки. Функция возвращает код ошибки установки пароля. Коды ошибок аналогичны приведенным в описании функции ValidatePassword().

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

ValidatePassword

uint2 ValidatePassword(string password)

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

Входной параметр – пароль в виде строки. Функция возвращает код несоответствия парольным политикам. Если функция возвращает 0, ошибок нет.

Коды ошибок, возвращаемых функцией
Возвращаемое значение Описание ошибки
1 Не используется.
2 Длина пароля не соответствует требуемой.
4 В пароле отсутствуют цифры.
8 В пароле отсутствуют символы верхнего регистра.
16 В пароле отсутствуют символы нижнего регистра.
32 В пароле отсутствуют специальные символы.
64 Ошибка при чтении значений прав, устанавливающих сложность пароля для пользователя.
128 Пароль должен отличаться от предыдущих паролей.
256 Пароль не должен содержать пробелы.
512 Ошибка при чтении значения права, устанавливающего минимальную длину пароля.
1024 Пароль не может быть пустым.

При возникновении нескольких ошибок, их коды складываются. Например, получено значение 18. Это сумма 2 и 16, где 2 – недопустимая длина пароля, а 16 – отсутствие символов нижнего регистра.

Подсистема безопасности Alpha.Security не накладывает требований к содержанию пароля. Требования к паролю устанавливаются путем назначения прав из стандартного приложения Alpha.Security: Количество в пароле символов в нижнем регистре (LowerCount), Количество в пароле символов в верхнем регистре (UpperCount), Количество цифровых символов в пароле (NumberCount), Сложность пароля (PasswordComplexity), Минимальная длина пароля (PasswordMinLength), Количество специальных символов в пароле (SpecialCount).

GetGroupsList

string GetGroupsList()

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

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

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

Вызов: SecurityManagerUser.GetGroupsList()

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

{
 "data": [
  {
   "groupID": "alpha:ab5cc552-a515-48ab-9e82-436aabf6bdfc",
   "groupName": "Диспетчеры"
  }
 ]
}

GetApplicationsList

string GetApplicationsList()

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

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

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

Вызов: SecurityManagerUser.GetApplicationsList()

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

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

GetRoles

string GetRoles(string appID)

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

Входной параметр – ID приложения, из которого требуется получить список ролей (тип значения – string).

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

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

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

{
 "data": [
  {
   "roleID": "alpha:ec5b145e-7d43-4c18-934c-1da6d4cb407f",
   "roleName": "rolename"
  }
 ]
}

GetRights

string GetRights(string appID)

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

Входной параметр – ID приложения, из которого требуется получить список прав (тип значения – string).

Возвращает данные в JSON-формате. Для строковых прав значения (если их несколько) разделены сочетанием символов \n.

Для получения списка эффективных прав используйте функцию GetEffectiveRights.

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

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

{
 "data": [
  {
   "appName": "Управление состоянием оборудования",
   "tokenType": "bool",
   "tokenName": "Управление резервуаром",
   "tokenDescription": "Право управления резервуаром",
   "ownerId": "alpha:07dba445-1903-498c-abdf-af7f55c145c4",
   "tokenValueAllow": "TRUE",
   "tokenValueDeny": "FALSE"
  }
 ]
}

GetEffectiveRights

string GetEffectiveRights(string appID)

Предоставляет список эффективных прав пользователя, чья учетная запись загружена в элемент, из указанного приложения.

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

Возвращает данные в JSON-формате. Для строковых прав значения (если их несколько) разделены сочетанием символов \n.

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

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

{
 "data": [
  {
   "appName": "Управление состоянием оборудования",
   "tokenType": "bool",
   "tokenName": "Управление резервуаром",
   "tokenDescription": "Право управления резервуаром",
   "ownerId": "alpha:07dba445-1903-498c-abdf-af7f55c145c4",
   "tokenValueAllow": "TRUE",
   "tokenValueDeny": "FALSE"
  }
 ]
}

New

void New()

Освобождает элемент от загруженной в него информации для создания нового приложения.

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

Вызов: SecurityManagerUser.New()

После создания новой учетной записи не забудьте загрузить её в подсистему безопасности с помощью функции Save().

AddRole

void AddRole(string roleUID)

Назначает указанную роль пользователю, чья учетная запись загружена в элемент.

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

Вызов: SecurityManagerUser.AddRole("alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20")

DeleteRole

void DeleteRole(string roleUID)

Лишает указанной роли пользователя, чья учетная запись загружена в элемент.

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

Вызов: SecurityManagerUser.DeleteRole("alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20")

AddGroup

void AddGroup(string groupUID)

Добавляет в указанную группу пользователя, чья учетная запись загружена в элемент.

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

Вызов: SecurityManagerUser.AddGroup("alpha:ffdad1f9-ae36-4980-82b8-c7180a63b451")

DeleteGroup

void DeleteGroup(string groupUID)

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

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

Вызов: SecurityManagerUser.DeleteGroup("alpha:ffdad1f9-ae36-4980-82b8-c7180a63b451")

AddRight

void AddRight(string appID, string rightName, uint1 rightType, string allowedValue, string forbidenValue)

Назначает право пользователю, чья учетная запись загружена в элемент.

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

  • ID приложения, содержащего право (тип значения – string);
  • имя права (тип значения – string);
  • тип права (тип значения – uint1):
    • 0 – строковый;
    • 1 – логический;
  • разрешающее значение права (тип значения – string);
  • запрещающее значение права (тип значения – string).

Для строковых прав значения (если их несколько) можно разделить с помощью сочетания символов \n. Пример: "значение1\nзначение2\nзначение3".

Вызов: SecurityManagerUser.AddRight("Управление состоянием оборудования","Управление насосом",1,"true","false")

ChangeRight

void ChangeRight(string appID, string rightName, string allowedValue, string forbidenValue)

Меняет значения прав пользователя, чья учетная запись загружена в элемент.

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

  • ID приложения, содержащего право (тип значения – string);
  • имя права (тип значения – string);
  • новое разрешающее значение права (тип значения – string);
  • новое запрещающее значение права (тип значения – string).

Для строковых прав значения (если их несколько) можно разделить с помощью сочетания символов \n. Пример: "значение1\nзначение2\nзначение3".

Вызов: SecurityManagerUser.ChangeRight("Управление состоянием оборудования","Управление насосом","false","true")

DeleteRight

void DeleteRight(string appID, string rightName)

Лишает права пользователя, чья учетная запись загружена в элемент.

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

  • ID приложения, содержащего право (тип значения – string);
  • имя права (тип значения – string).

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

GetErrorDescriptionByCode

string GetErrorDescriptionByCode(uint1 FailReasonCode)

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

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