SecurityLogApi
extends SecurityLogApi
in package
Security Logs API gives you the possibility to get information about organization security activities.
Table of Contents
Methods
- getOrganizationSecurityLog() : SecurityLog|null
- Get Organization Security Log
- getUserSecurityLog() : SecurityLog|null
- Get User Security Log
- listOrganizationSecurityLogs() : ModelCollection
- List Organization Security Logs
- listUserSecurityLogs() : ModelCollection
- List User Security Logs
Methods
getOrganizationSecurityLog()
Get Organization Security Log
public
getOrganizationSecurityLog(int $securityLogId) : SecurityLog|null
Parameters
- $securityLogId : int
Tags
Return values
SecurityLog|nullgetUserSecurityLog()
Get User Security Log
public
getUserSecurityLog(int $userId, int $securityLogId) : SecurityLog|null
Parameters
- $userId : int
- $securityLogId : int
Tags
Return values
SecurityLog|nulllistOrganizationSecurityLogs()
List Organization Security Logs
public
listOrganizationSecurityLogs([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $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[userId]
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionlistUserSecurityLogs()
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]