Otp
Otp - класс, реализующий многофакторную аутентификацию. Содержит в себе большую часть логики MFA. В типичном случае использования OTP нужно обращаться к методам именно этого класса.
| Метод | Описание | С версии |
|---|---|---|
| activate | Активирует OTP для пользователя. | 14.5.6 |
| canSkipMandatory | Проверяет, может ли пользователь пропускать обязательность использования OTP. | 14.5.6 |
| canSkipMandatoryByRights | Проверяет, обязывают ли права пользователя подключать OTP. | 15.0.2 |
| deactivate | Деактивирует OTP для пользователя на необходимое количество дней или навсегда. | 14.5.6 |
| defer | Откладывает обязательное подключение OTP на необходимое количество дней или навсегда. | 14.5.6 |
| delete | Удаляет записи OTP из базы данных. | 14.5.6 |
| getAlgorithm | Возвращает инстанс использованного алгоритма OTP. | |
| getAppSecret | Возвращает сгенерированный токен мобильного приложения, использующийся для ручной инициализации устройства. | 14.5.6 |
| getAttempts | Возвращает счетчик количества попыток подтверждения. | 14.5.6 |
| getAvailableTypes | Возвращает доступные типы алгоритма OTP. | 14.5.6 |
| getByType | Возвращает новый инстанс с необходимым алгоритмом OTP. | 14.5.6 |
| getByUser | Возвращает новый инстанс для пользователя по его ID. | 14.5.6 |
| getContext | Возвращает контекст текущего запроса. | 15.0.7 |
| getDefaultType | Возвращает тип алгоритма OTP, установленный по умолчанию. | 14.5.6 |
| getDeferredParams | Возвращает отложенные параметры. | 14.5.6 |
| getHexSecret | Возвращает секрет, перекодированный в шестнадцатеричную систему счисления. | 14.5.6 |
| getIssuer | Возвращает параметр идентификации провайдера или сервиса. | |
| getLabel | Возвращает метку для параметра идентификации провайдера или сервиса. | |
| getMandatoryRights | Возвращает набор прав пользователей, для которых использование OTP обязательно. | 14.5.6 |
| getParams | Возвращает пользовательские параметры (например счетчик для HotpAlgorithm - \Bitrix\Security\Mfa\HotpAlgorithm). | |
| getProvisioningUri | Возвращает URI для подключения мобильного приложения в соответствии с KeyUriFormat. | |
| getSecret | Возвращает сгенерированный секрет. | |
| getSkipMandatoryDays | Возвращает период (в днях) для установки обязательности использования OTP. | 14.5.6 |
| getSyncParameters | Возвращает синхронизированные параметры пользователя для предоставленного ввода. | |
| getType | Возвращает использованный тип алгоритма OTP. | 14.5.6 |
| getTypesDescription | Возвращает описание доступных типов алгоритмов OTP. | 14.5.6 |
| getUserId | Возвращает ID пользователя, привязанного к инстансу OTP. | 14.5.6 |
| getUserLogin | Возвращает логин пользователя. | 14.5.6 |
| isActivated | Возвращает, активно ли OTP или нет. | 14.5.6 |
| isAttemptsReached | Проверяет достигнуто ли количество попыток авторизации, разрешенное политикой безопасности. | 14.5.6 |
| isCaptchaRequired | Метод определяет, должен ли пользователь заполнить код-captcha перед тем, как предоставить пароль OTP. | 14.5.6 |
| isMandatorySkipped | Возвращает true если обязательное использование OTP может быть пользователем пропущено. | 14.5.6 |
| isMandatoryUsing | Метод определяет, активировано ли обязательно использование OTP. | 14.5.6 |
| isOtpEnabled | Метод определяет, включен ли механизм OTP. | 14.5.6 |
| isOtpRequired | Возвращает true, если пользователь должен проходить OTP со своего устройства. | 14.5.6 |
| isOtpRequiredByMandatory | Возвращает true, если пользователь не использует OTP, но это необходимо и истекло количество дней до подключения. | 14.5.6 |
| isRecoveryCodesEnabled | Метод определяет возвращает, включены ли резервные коды. | 15.0.0 |
| regenerate | Заново инициализирует OTP (генерируется новый случайный токен (секрет), устанавливается стандартный алгоритм и т.д.). | 14.5.6 |
| save | Сохраняет все данные OTP в базу данных. | 14.5.6 |
| setActive | Устанавливает новый статус активации. | 14.5.6 |
| setAppSecret | Устанавливает новый секрет мобильного приложения. | 14.5.6 |
| setContext | Устанавливает контекст текущего запроса. | 15.0.7 |
| setDefaultType | Устанавливает по умолчанию тип алгоритма OTP. | 14.5.6 |
| setDeferredParams | Устанавливает или удаляет отложенные параметры. | 14.5.6 |
| setHexSecret | Устанавливает новый секрет в шестнадцатеричной системе счисления. | 14.5.6 |
| getInitialDate | Возвращает дату инициализации OTP. | 14.5.6 |
| setIssuer | Установить пользовательский параметр идентификации провайдера или сервиса. | |
| setLabel | Устанавливает пользовательскую метку. | |
| setMandatoryRights | Устанавливает для прав пользователя обязательное использование OTP. | 14.5.6 |
| setMandatoryUsing | Метод служит для активации или деактивации использования OTP. | 14.5.6 |
| setSecret | Устанавливает новый секрет. | 14.5.6 |
| setSkipMandatoryDays | Метод определяет период (в днях) для установки обязательности использования OTP. | 14.5.6 |
| setType | Устанавливают новый тип алгоритма OTP. | 14.5.6 |
| setUserInfo | Устанавливает новую пользовательскую информацию. | 14.5.6 |
| setUserLogin | Устанавливает пользовательский логин. | 14.5.6 |
| syncParameters | Синхронизирует пользовательские параметры для предоставленного ввода. | |
| syncParameters | Синхронизирует пользовательские параметры для предоставленного ввода. | |
| verify | Подтверждает введенные пользователем данные. | |
| verifyUser | Отвечает за комплексную проверку OTP. | 14.5.6 |
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Пользовательские комментарии
Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.Для этого нужно всего лишь авторизоваться на сайте
Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.
Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.