ESET\SecureAuthentication\SDK\IAuditor Interface Reference

Inheritance diagram for ESET\SecureAuthentication\SDK\IAuditor:

Public Member Functions
	authenticationSuccess ($userId, $authenticatedCredential)
	authenticationFailure ($userId, $authenticatedCredential)
	authenticationLocked ($userId, $authenticatedCredential)
	preAuthentication ($userId, $expectedCredential)
	preAuthenticationLocked ($userId)
	provisionApp ($userId)
	provisionTextMessage ($userId)
	deProvision ($userId)
	userLocked ($userId)
	userUnlocked ($userId)
	userCreated ($userId)

Member Function Documentation

ESET\SecureAuthentication\SDK\IAuditor::authenticationFailure	(		$userId,
			$authenticatedCredential
	)

User authentication was unsuccessful

Parameters

string	$userId	Username
int	$authenticatedCredential	CredentialTypes constant CredentialTypes

Implemented in ESET\SecureAuthentication\SDK\Internal\Auditing\LoggingAuditor.

ESET\SecureAuthentication\SDK\IAuditor::authenticationLocked	(		$userId,
			$authenticatedCredential
	)

User authentication failed due to locked account

Parameters

string	$userId	Username
int	$authenticatedCredential	CredentialTypes constant CredentialTypes

Implemented in ESET\SecureAuthentication\SDK\Internal\Auditing\LoggingAuditor.

ESET\SecureAuthentication\SDK\IAuditor::authenticationSuccess	(		$userId,
			$authenticatedCredential
	)

User authentication was successful

Parameters

string	$userId	Username
int	$authenticatedCredential	CredentialTypes constant CredentialTypes

Implemented in ESET\SecureAuthentication\SDK\Internal\Auditing\LoggingAuditor.

ESET\SecureAuthentication\SDK\IAuditor::deProvision

(

$userId

)

User has been de-provisioned (2FA disabled)

Parameters

string

$userId

Username

Implemented in ESET\SecureAuthentication\SDK\Internal\Auditing\LoggingAuditor.

ESET\SecureAuthentication\SDK\IAuditor::preAuthentication	(		$userId,
			$expectedCredential
	)

User pre-authentication successful

Parameters

string	$userId	Username
int	$expectedCredential	CredentialTypes constant CredentialTypes

Implemented in ESET\SecureAuthentication\SDK\Internal\Auditing\LoggingAuditor.

ESET\SecureAuthentication\SDK\IAuditor::preAuthenticationLocked

(

$userId

)

User pre-authentication failed due to locked account

Parameters

string

$userId

Username

Implemented in ESET\SecureAuthentication\SDK\Internal\Auditing\LoggingAuditor.

ESET\SecureAuthentication\SDK\IAuditor::provisionApp

(

$userId

)

User has been provisioned for mobile app OTPs (2FA enabled)

Parameters

string

$userId

Username

Implemented in ESET\SecureAuthentication\SDK\Internal\Auditing\LoggingAuditor.

ESET\SecureAuthentication\SDK\IAuditor::provisionTextMessage

(

$userId

)

User has been provisioned for text message OTPs (2FA enabled)

Parameters

string

$userId

Username

Implemented in ESET\SecureAuthentication\SDK\Internal\Auditing\LoggingAuditor.

ESET\SecureAuthentication\SDK\IAuditor::userCreated

(

$userId

)

A new 2FA user account has been created

Parameters

string

$userId

Username

Implemented in ESET\SecureAuthentication\SDK\Internal\Auditing\LoggingAuditor.

ESET\SecureAuthentication\SDK\IAuditor::userLocked

(

$userId

)

User account has been locked

Parameters

string

$userId

Username

Implemented in ESET\SecureAuthentication\SDK\Internal\Auditing\LoggingAuditor.

ESET\SecureAuthentication\SDK\IAuditor::userUnlocked

(

$userId

)

User account has been unlocked

Parameters

string

$userId

Username

Implemented in ESET\SecureAuthentication\SDK\Internal\Auditing\LoggingAuditor.