Documentation

SecurityLogApi extends AbstractApi
in package

Security Logs API gives you the possibility to get information about user security activities.

Table of Contents

Methods

getUserSecurityLog()  : SecurityLog|null
Get User Security Log
listUserSecurityLogs()  : ModelCollection
List User Security Logs

Methods

listUserSecurityLogs()

List User Security Logs

public listUserSecurityLogs(int $userId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
$userId : int
$params : array<string|int, mixed> = []

string $params[event] Enum: "login" "password.set" "password.change" "email.change" "login.change" "personal_token.issued" "personal_token.revoked" "mfa.enabled" "mfa.disabled" "session.revoke" "session.revoke_all" "sso.connect" "sso.disconnect" "user.registered" "user.remove" "application.connected" "application.disconnected" "webauthn.created" "webauthn.deleted" "trusted_device.remove" "trusted_device.remove_all" "device_verification.enabled" "device_verification.disabled"
string $params[createdAfter]
string $params[createdBefore]
string $params[ipAddress]
integer $params[limit]
integer $params[offset]

Tags
link

API Documentation

link

API Documentation Enterprise

Return values
ModelCollection

        
On this page

Search results