method public

Otp::setUserInfo()

Сигнатура

public setUserInfo(array<string|int, mixed> $userInfo) : $this

Описание

Устанавливает новую информацию о пользователе. В основном используется для инициализации из БД. Сейчас поддерживается: - ACTIVE: bool, состояние активации (см. setActive) - USER_ID: integer, User ID (см. setUserId) - ATTEMPTS: integer, счётчик попыток (см. setAttempts) - SECRET: binary, secret пользователя (см. setSecret) - PARAMS: string, параметры пользователя (см. setParams и getSyncParameters) - INITIAL_DATE: Type\Date, начальная дата OTP (см. setInitialDate)

Параметры

$userInfo array<string|int, mixed>

См. выше.

Возвращаемое значение

$this

Как применяется в Otp

Otp::setUserInfo() — метод класса \Bitrix\Security\Mfa\Otp модуля «Проактивная защита».

Метод объекта: сначала нужен экземпляр Otp.

use Bitrix\Main\Loader;
use Bitrix\Security\Mfa\Otp;

Loader::includeModule('security');

/** @var Otp $object */
$userInfo = [];
$result = $object->setUserInfo($userInfo);
// $result: $this

Другие методы Otp

activate() Активирует OTP пользователя.
canSkipMandatory() Проверяет, может ли текущий пользователь пропустить обязательное использование OTP.
canSkipMandatoryByRights() Проверяет, что текущий пользователь не включён в обязательные права
deactivate() Отключает OTP пользователя на необходимое количество дней или навсегда
defer() Откладывает обязательное использование OTP пользователем на необходимое количество дней или навсегда
delete() Удаляет запись OTP из БД
getAlgorithm() Возвращает экземпляр используемого OtpAlgorithm
getAppSecret() Возвращает secret мобильного приложения, используемый для ручной инициализации устройства
getAttempts() Возвращает количество попыток проверки
getAvailableTypes() Возвращает доступные типы OtpAlgorithm
getByType() Возвращает новый экземпляр с требуемым типом OtpAlgorithm
getByUser() Возвращает новый экземпляр для пользователя, заданного по user ID

Исходный файл: source/security/lib/mfa/otp.php:494