Skip to main content

Audit trails

Audit Trails allow administrators to closely monitor and track a wide range of crucial user member activities. This includes:

  • keeping track of SDK builds
  • monitoring documentation approvals
  • watching for new users or user role changes
  • creation or removal of tokens for CI/CD pipelines
  • tracking PR publishing

Audit Trails empowers organization admins with enhanced visibility and control over the platform, ensuring that all important actions are recorded and can be easily reviewed when needed.

View audit trails​

The Audit Trails tab is located within the admin section and is used to see audit trails for your organization.

The audit trails menu item The audit trails menu item

This option is only available to organization admins.

From here you can see the audit trails. For actions that generate an SDK build, you can follow the link to the build to see more details.

The audit trails showing a user being created, verifying their email, creating an API, doing an SDK build, and creating a CI token The audit trails showing a user being created, verifying their email, creating an API, doing an SDK build, and creating a CI token

You can filter this list by the email, to find events from a specific user.

Export audit trails​

Audit trails can be exported to a CSV file. This is useful for archiving or for further analysis. To export the audit trails, select the Export to CSV button.

The export to CSV button to the right of the audit trail list and search bar The export to CSV button to the right of the audit trail list and search bar

The exported CSV file has the following columns:

ColumnDescription
NameThe name of the user that performed the action.
EmailThe email address of the user that performed the action.
OrgThe organization that the user is a member of.
EventThe name of the event that was audited. You can find a list of the events in the User events that are audited section below.
TimeThe time that the event occurred in UTC.
URLIf the event is a build, the URL to the build details.

User events that are audited​

Event NameDescription
User CreateThe user create event is audited whenever a new user is created in our system. Its purpose is to maintain a complete and accurate record of all user creations, allowing us to track user growth and analyze trends over time.
User Verified EmailThe user verified email event is tracked when a user validates their email address. It ensures that the email validation process is properly documented and can be traced if needed.
User Create APIThe user create api event is recorded when a new API is added to our system during the initial SDK build process. The audit log includes the name and ID of the API record, which can be viewed by organization admins for more details.
User BuildThe user build event tracks the occurrence of an SDK generation performed by our CLI. The corresponding audit entry contains the API name linked to the build and a unique build ID. Organization admins can access the build details, including the programming language SDKs included in the build, and approve or unapprove any associated documents.
User Approved docWhenever a user approves a document, the the user approved doc event is tracked.. The audit entry displays the ID of the approved document, and organization admins can preview the API documentation by clicking on the document ID.
User Unapproved docLikewise, when a user unapproves a document, the user unapproved doc event is tracked. The audit entry displays the ID of the unapproved document, and organization admins can preview the API documentation by clicking on the document ID.
User Published PRWhen a user publishes a pull request (PR) from the CLI for a specific programming language SDK, the publish PR event is tracked. The audit entry includes the name of the SDK and the associated programming language.
User Publish PR FailureSimilarly, if a pull request fails to publish, the user publish pr failure event is tracked. The audit entry includes the name of the SDK and the associated programming language.
User Invite MemberThe user invite member event is tracked whenever a user invites someone via email to join their organization. Users can invite new members through the liblab Portal, and the audit entry includes the email address of the invited individual.
User Add CI TokenWhen a user adds a Continuous Integration (CI) token through the Command Line Interface (CLI), the user add CI token event is tracked. The audit entry includes the token name, and the ID associated with the generated token.
User Remove CI TokenSimilarly, when a user removes a Continuous Integration (CI) token through the CLI, the user remove CI token event is tracked. The audit entry only includes the ID associated with the removed token.
Last updated on