Audit log
The Trelica audit log is a valuable source of event data. The audit log can be viewed and filtered within the Trelica application but the API end-point provides a rich way to access raw, detailed data from other tools.
get
https://app.trelica.com/api
/audit/v1/logs
List audit log events
Attribute | Type | Description |
---|---|---|
id | integer | The Trelica ID for the event |
published | datetime | The date/time the event occurred |
eventType | string | |
actor | object | |
client | object | |
target | array | |
details | array | Optional. Detailed information about the event. The structure varies depending on the event type. e.g. field value changes or numbers of objects updated by an integration. |
Attribute | Type | Description |
---|---|---|
id | integer | The Trelica ID for the user |
alternateId | string | The user's email address |
type | string | Currently always User |
displayName | string | The actor's name |
Attribute | Type | Description |
---|---|---|
id | string | The Trelica ID for the target |
type | string | Optional. The type of the target e.g. CustomerIntegration |CustomerApp | ApiClient |
displayName | string | Optional. The name of the target. |
Attribute | Type | Description |
---|---|---|
ipAddress | string | IP address |
The audit log contains a lot of information so you will typically want to limit the data returned. There are three ways to do this:
Use the
since
and until
parameters to view data between two points in time.The
q
parameter lets you pass a simple text query. This searches the follow fields:Field value matches query exactly | Field value contains query text |
---|---|
Event ID | Actor user full name |
Target user full name | |
Target ID | Target object name |
Target Type | |
The audit log end-point supports SCIM-style filters which allow you to carry out more sophisticated filtering, e.g. for specific event types, IP addresses, or users.
Each audit event has a type. The current list of event types is shown here and can be downloaded as a JSON file.
Event Type | Description |
---|---|
account_requested | Account requested |
app_license_created | App license added |
app_license_deleted | App license removed |
app_license_modified | App license updated |
app_license_terminated | App license terminated |
app_modified | Application updated |
app_owner_added | App owner added |
app_owner_removed | App owner removed |
application_created | API App created |
application_deleted | API App deleted |
application_modified | API App modified |
application_published | API App published |
application_submitted | API App submitted |
application_unpublished | API App unpublished |
audit_log_exported | Audit log exported |
change_provider_rankings | Integration provider rankings changed |
contact_created | Contact created |
contact_invitation_redeemed | Contact invitation redeemed |
contact_invited | Contact invited |
contact_modified | Contact modified |
customer_app_created | Application created |
customer_app_deleted | Application deleted |
customer_app_modified | Application updated |
customer_created | Customer created |
customer_email_domain_added | Email domain added |
customer_email_domain_removed | Email domain removed |
customer_modified | Customer modified |
customer_supported_currency_added | Currency added |
customer_supported_currency_removed | Currency removed |
customer_user_created | User added to customer |
employee_login_success | Login - success |
integration_apps_found | Apps found |
integration_completed | Integration completed |
integration_connected | Integration connected |
integration_disconnected | Integration disconnected |
integration_failed | Integration failed |
integration_failed_users_found | Users found |
integration_high_risk_apps | High-risk apps found |
integration_no_apps_found | Apps found |
integration_no_payments_found | Payments found |
integration_no_users_found | Users found |
integration_payments_found | Payments found |
integration_reconnect_required | Integration reconnect required |
integration_reconnected | Integration reconnected |
integration_refreshed | Integration refreshed |
integration_spend_configuration_modified | Spend configuration changed |
integration_users_found | Users found |
invitation_sent | Invitation email sent |
license_renewal_reminder_settings_created | License renewal reminder created |
license_renewal_reminder_settings_modified | License renewal reminder modified |
login_failure | Login - failure |
login_success | Login - success |
logout | Logout |
password_reset_sent | Password reset email sent |
person_created | Profile created |
person_deleted | Profile deleted |
person_modified | Profile changed |
saml_idp_created | Saml identity provider added |
saml_idp_modified | Saml identity provider modified |
saml_idp_removed | Saml identity provider removed |
saml_settings_updated | Saml settings updated |
user_2fa_enabled | Two factor authentication enabled |
user_2fa_info_missing | Two factor authentication info missing |
user_2fa_key_reset | Two factor authentication key reset |
user_2fa_recovery_codes_generated | Two factor authentication recovery codes generated |
user_consent_declined | Declined grant |
user_consent_granted | Consent grant |
user_consent_revoked | Consent revoked |
user_created | Created |
user_deleted | Deleted |
user_disabled | Disabled |
user_email_confirmed | Email confirmed |
user_enabled | Enabled |
user_external_login_added | External login added |
user_external_login_removed | External login removed |
user_modified | Modified |
user_password_added | Password added |
user_password_change | Password changed |
user_password_reset | Password reset |
users_exported | Users list exported |
auditEventTypes.json
8KB
Code
Download the list as a JSON file
Last modified 5mo ago