Methods |
public
|
init()
|
#
|
public
|
getUsedDevicesManager(): Manager
|
#
|
public
|
GetSettings(): array
Obtains list of module settings for authenticated user.
Obtains list of module settings for authenticated user.
Overrides
|
#
|
public
|
UpdateSettings($ShowRecommendationToConfigure)
|
#
|
public
|
GetUserSettings(int $UserId): array|null
Obtains user settings. Method is allowed for superadmin only.
Obtains user settings. Method is allowed for superadmin only.
|
#
|
public
|
onAfterDeleteUser($aArgs, &$mResult)
|
#
|
public
|
DisableUserTwoFactorAuth(int $UserId): boolean
Disables two factor authentication for specified user. Method is allowed for superadmin only.
Disables two factor authentication for specified user. Method is allowed for superadmin only.
|
#
|
public
|
RegisterAuthenticatorAppBegin(string $Password): bool|array
Verifies user's password and returns Secret and QR-code
Verifies user's password and returns Secret and QR-code
|
#
|
public
|
RegisterAuthenticatorAppFinish(string $Password, string $Code, string $Secret): boolean
Verifies user's Code and saves Secret in case of success
Verifies user's Code and saves Secret in case of success
Throws
|
#
|
public
|
DisableAuthenticatorApp(string $Password): bool
Verifies user's Password and disables TwoFactorAuth in case of success
Verifies user's Password and disables TwoFactorAuth in case of success
|
#
|
public
|
VerifyAuthenticatorAppCode(string $Code, $Login, $Password): bool|array
Verifies Authenticator code and returns AuthToken in case of success
Verifies Authenticator code and returns AuthToken in case of success
Throws
|
#
|
public
|
GetBackupCodes(string $Password): array|boolean
Verifies user's password and returns backup codes generated earlier.
Verifies user's password and returns backup codes generated earlier.
|
#
|
public
|
GenerateBackupCodes(string $Password): array|boolean
Verifies user's password, generates backup codes and returns them.
Verifies user's password, generates backup codes and returns them.
|
#
|
public
|
VerifyBackupCode($BackupCode, $Login, $Password)
|
#
|
public
|
onAfterAuthenticate(array $aArgs, aray &$mResult)
Checks if User has TwoFactorAuth enabled and return UserId instead of AuthToken
Checks if User has TwoFactorAuth enabled and return UserId instead of AuthToken
|
#
|
public
|
RegisterSecurityKeyBegin(string $Password): array|boolean
Verifies user's password and returns arguments for security key registration.
Verifies user's password and returns arguments for security key registration.
|
#
|
public
|
RegisterSecurityKeyFinish(array $Attestation, string $Password): boolean
Verifies user's password and finishes security key registration.
Verifies user's password and finishes security key registration.
Throws
|
#
|
public
|
VerifySecurityKeyBegin(string $Login, string $Password): array|boolean
Authenticates user and returns arguments for security key verification.
Authenticates user and returns arguments for security key verification.
|
#
|
public
|
VerifySecurityKeyFinish(string $Login, string $Password, array $Attestation): boolean
Authenticates user and finishes security key verification.
Authenticates user and finishes security key verification.
Throws
|
#
|
public
|
UpdateSecurityKeyName(int $KeyId, string $NewName, string $Password): boolean
Verifies user's password and changes security key name.
Verifies user's password and changes security key name.
|
#
|
public
|
DeleteSecurityKey(int $KeyId, string $Password): boolean
Verifies user's password and removes secutiry key.
Verifies user's password and removes secutiry key.
|
#
|
public
|
VerifyPassword(string $Password): boolean
Verifies user's password.
Verifies user's password.
|
#
|
public
|
EntryVerifySecurityKey()
|
#
|
public
|
EntryAssetlinks()
|
#
|
public
|
TrustDevice($DeviceId, $DeviceName)
|
#
|
public
|
SaveDevice($DeviceId, $DeviceName)
|
#
|
public
|
GetUsedDevices()
|
#
|
public
|
RevokeTrustFromAllDevices()
|
#
|
public
|
onBeforeLogout($aArgs, &$mResult)
|
#
|
public
|
LogoutFromDevice($DeviceId)
|
#
|
public
|
RemoveDevice($DeviceId)
|
#
|