Table of contents

After installation, you will see User Activity Audit Log in the "Apps" administration menu:

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 able to use the app (The “generate activity log” button will be disabled):

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.

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.

To see the status of the historical data sync, go to Settings (top right corner of the app) and Historic log sync:

From here you can see the the following information:

• App installation date

• Historical log date

  • The earliest date from when the logged actions will be synced and displayed in the app cannot be earlier than January 1st, 2022.

• “Sync historical logs” button to re-retrieve the historical data

  • After clicking the button you will see the confirmation popup and the status of the sync, while it is in progress.

  • 

• List of the actions that can be synced:

• Total: Number of the actions

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 + access Settings and configure the app.

• Manager: can access all the logs in the app, but cannot access Settings and configure the app (the Settings are invisible for Manager).

To define roles for certain users, go to Settings (top right corner of the app) and click “Permissions“ in the left menu:

To add a user to the app, search and select the user or group from the dropdown menu, 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 Save:

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:

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.

To enable displaying the asset-related actions, go to Settings (top right corner of the app) and click “Assets audit log“ in the left 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.

• 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"}]}

• 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.

After filling in the three fields, click “Connect“ button. After Sync starts, the Pending Connection status“ message will be displayed. If the connection is successful, you will see the corresponding message:

If there is an error in the filled fields, you will see the corresponding error message:

You can also disable the connection to Assets by clicking the Delete connection button while editing the connection:

Configuring Atlassian Guard (formerly Access) connection

If Atlassian Guard (formerly Access) is activated on your Cloud instance, you can retrieve three additional user actions:

• User reactivated

• User deactivated

• User last active (Date/time)

• User removed from site

• User invited to site

• User detail changed

To be able to view these actions, you need to configure a connection with Atlassian Guard. To do so, go to Settings (top right corner of the app) and click “Organization audit log“ in the left menu.

Enter two values in the corresponding fields:

• Organization ID

• API Key

To create/view both values, follow the instructions and click Connect. If the values are correct, you will see the success message, otherwise, a status/error notification will be displayed:

Configuring Jira Administration Audit Log connection [coming soon!]

Webhooks

You can use app webhooks to receive real-time updates for all the actions registered in the app. To do so, go to Settings (top right corner of the app) and click “Webhooks“ in the left menu.

To add a webhook endpoint URL, enter the URL in the “URL“ field and click Save:

The URL will be added to the list on the right:

From here you can add more endpoints, or

• Modify the existing one (you can edit URL)

• Mute the URL (a confirmation screen will be shown and if confirmed the API will be paused and will not receive the action data):

• 

• Unmute the muted URL (a confirmation screen will be shown and if confirmed the API will activate and will again receive the action data):

• 

• Delete the webhook:

• 

JSON format

{
  "accountId": "ACTOR_ACCOUNT_ID",
  "accountName": "ACTOR_DISPLAY_NAME",
  "avatar": "ACTOR_AVATAR",
  "instanceName": "EVENT_INSTANCE_ADDRESS",
  "issueKey": "ISSUE_KEY",
  "requestTypeName": "REQUEST_TYPE_NAME",
  "issueTypeName": "ISSUE_TYPE_NAME",
  "actionType": "OCCURRED_ACTION",
  "target": "EVENT_TYPE",
  "projectKey": "PROJECT_KEY",
  "projectName": "PROJECT_NAME",
  "changedFrom": "OLD VALUE",
  "changedTo": "NEW VALUE",
  "createdAt": "EVENT_DATE",
  "objectId": "COMMON_OBJECT_ID",
  "summary": "ISSUE_SUMMARY"
}

Configuring Monitor fields [coming soon!]