API audit events

Audit event types

This section contains all audit event types that apply to Unstructured and Complex Documents.

Project management

Event type	Description
ucd_project_created	An Unstructured and Complex Documents project is created.
ucd_project_deleted	An Unstructured and Complex Documents project is deleted.

Model management

Event type	Description
model_version_published	A model is published.
model_version_unpublished	A model tag is updated.
model_tag_deleted	A published model is deleted.

Dataset management

Event type	Description
get_datasets	Datasets are retrieved.
get_datasets_by_owner	Datasets are retrieved by owner.
get_dataset	A specific dataset is retrieved.
export_dataset	A dataset is exported.

User management

Event type	Description
create_user	A new user is created.
delete_user	A user is deleted.
get_users	User information is retrieved.
update_user	User information is modified.

Authentication and security

Event type	Description
login_success	Successful user login.
authentication_failed_password	Failed login due to wrong password.
authentication_failed_totp	Failed login due to wrong TOTP code.
login_failed_ip_address	Failed login due to IP address restrictions.
revoke_api_tokens	API tokens are revoked.
revoke_login_tokens	Login tokens are revoked.
revoke_current_login_token	The current session token is revoked.
replace_api_token	API token is replaced.
authentication_failed_totp_lockout	Failed login due to TOTP lockout.

Password reset

Event type	Description
send_password_reset_success	Successful password reset email sent.
send_password_reset_failed_ip_address	IP blocked password reset.
verify_password_reset_success	Successful password reset verification.
verify_password_reset_failed_ip_address	IP blocked password reset verification.
change_password_success	Successful password change.
change_password_failed_totp	Password change failed due to TOTP.
change_password_failed_ip_address	IP blocked password change.
verify_password_reset_failed_signature	Invalid password reset signature.
verify_password_reset_failed_timestamp	Expired password reset link.
change_password_failed_current_password	Wrong current password provided.

Comment query

Event type	Description
comment_query_text	Text-based comment queries.
comment_query_sample	Sample comment queries.
comment_query_learning	Learning-related comment queries.
comment_query_any_label_asc	Label-based queries in ascending order.
comment_query_recent	Recent comments queries.
comment_query_by_label	Queries filtered by specific labels.
comment_query_diagnostic	Diagnostic comment queries.
comment_query_label_property	Label property queries.
comment_query_attachment_text	Attachment text queries.

Annotations

Event type	Description
get_annotations	Annotations are retrieved.
update_annotation	An annotation is modified.

Quota management

Event type	Description
quota_set	A quota is set.
quota_reset	A quota is reset.
quotas_get	Quotas are retrieved.

System and administration

Event type	Description
audit_event_query	Audit events are queried directly.