After installation, you will see User Activity Audit Log in the "Apps" administration menu:
...
| Info |
|---|
Initially only site- and org-admins can access the app. Users access can be defined in Permissions. |
After clicking User Activity Audit Log, you will be navigated to the home page of the app:
...
After the expiration of the license, you will see the corresponding message and will not be to use the app (Generate activity log button will be disabled):
...
| Info |
|---|
If you access the app for the first time, you will be presented to a brief onboarding session, displaying the main features of the app. You can dismiss the session at any step. |
...
| Info |
|---|
If you have IP allowlisting enabled on your Cloud instance (this is possible Jira for Premium plans), please contact us for the IP to be added to the cloud allowlist. Without this, some actions will not be logged. |
Historical Actions in the Logs
For all the actions it is possible to see the log starting from the installation of the plugin. However, for the issue- and asset-related actions, also historical data, starting from January 1st, 2022 will be also available in the app. With the first install, you will see the corresponding informational message:
...
After the first install, depending on the number of issues and Asset objects, retrieving historical data may take from minutes to hours.
The actions on the following components are not available in the historical data and only the actions done after the app installation will be visible:
Global feature enable/disable
Board
Sprint
Version
Users
Project category
Comment update old value
Issue deleted
Actions from Jira administration audit log
Jira organization audit log
Assets audit log
Issue view
Permissions
You can define user roles for the Jira users who can access the plugin. There are two roles available in the app:
Administrator: can access all the logs in the app + define user permissions
Manager: can access all the logs in the app, but cannot define user permissions
| Info |
|---|
All Jira Administrators and Administrator permission in the app, by default. If a non-Administrator is added to the Manager role, the access to the projects where the user is not added will be given through the app. |
To define roles for certain users, go to Settings in the top ribbon of the app and click Permissions in the dropdown menu:
...
To add a user to the app, click the “+Add user” button:
...
You can search the user by name, email, or group and select the user from the list:
...
Define the role of the user and click Add:
...
After adding, the user will be added to the list:
...
For the users in the list, you can change the Role from the list itself:
...
| Info |
|---|
For the added users at least one Role should be selected. |
To remove the user from the Permissions, click Remove button and Delete button on the confirmation popup:
...
You can search users in the list by name or filter the list by role.
When a user, who does not have the right to use the app, tries to access the logs, the corresponding message will be displayed:
...
Configuring Assets Connection
The app includes action logs made on Assets (formerly Insight), namely object created and object updated.
| Info |
|---|
The delete actions of Asset objects cannot be logged. However, you can restore deleted objects with Insight Assets Backup & Migration plugin. |
To enable displaying the asset-related actions, go to Settings in the top ribbon of the app and click Assets audit log in the dropdown menu:
...
The configuration consists of several fields to be filled:
...
Email
Fill in the email related to the Atlassian account (valid JSM agent) that will be used to access the data in the Assets.
| Info |
|---|
Email is a mandatory field! |
Workspace ID
Fill in the ID of the Assets (Insight) workspace you want to configure backup for. The Workspace ID can be found on the following link: https://[yourcloud].atlassian.net/rest/servicedeskapi/insight/workspace. The Jira Service Management REST API uses the workspace Id to identify your individual instance of Assets (Insight), it is an alphanumeric string at the end of the text shown on the opened link with the following sample appearance:
3b3b70g5-66f8-3c01-a2d7-e5bbf2584dc3:{"size":1,"start":0,"limit":50,"isLastPage":true,"_links":{"self":"https://[yourcloud].atlassian.net/rest/servicedeskapi/assets/workspace","base":"https://[yourcloud].atlassian.net","context":""},"values":[{"workspaceId":"3b3b70g5-66f8-3c01-a2d7-e5bbf2584dc3"}]}
| Info |
|---|
Workspace ID is a mandatory field and can only be the Workspace ID of the current Cloud instance. |
API Token
Atlassian API token secures account access to the API. You can create a token, through the following URL: Atlassian account - API Tokens. You can read more about Atlassian API Token on the documentation page: Manage API tokens for your Atlassian account | Atlassian Support.
After creating an API Token, just copy and paste it into the corresponding “API Token“ field on the configuration page.
| Info |
|---|
API Token is a mandatory field! |
After filling the three fields in, click “Sync Assets Log“ button. After Sync starts, the “Connection status pending“message will be displayed. If there is an error in the filled fields, you will see the corresponding error message:
...
If the sync is successful the corresponding message will be displayed:
...
| Info |
|---|
After a successful connection, the Asset actions will be retrieved. Depending on the number of the objects, it may take from minute to hours. |
| Info |
|---|
The Asset action are retrieved every 6 hours, therefore the latest actions, done in the last 6 hours may not be shown in the logs. If you would like to sync the Asset actions immediately, go to “Assets audit log“ in the settings and click “Sync assets log“ button - depending on the number of the objects, it may take from minute to hours. |
Configuring Atlassian Access connection
If Atlassian Access is activated on your Cloud instance, you can retrieve three additional user actions:
User reactivated
User deactivated
User last active (Date/time)
To be able to view these actions, you need to configure a connection with Atlassian Access. To do so, click “Settings / Organization audit log” in the top menu:
...
After clicking, the configuration popup will show up:
...
Enter two values in the corresponding fields:
Organization ID
API Key
To create/view both values, follow the instructions and click Save. If the values are correct, you will see the success message, otherwise, a status/error notification will be displayed:
...
| Info |
|---|
After successful connections, the three related actions (user reactivation, deactivation and last activity date/time) will be retrieved every 1 hour. |