Org Users Only

CLOUD NEW

Org Users Only is designed to work in a Jira site with Assets.

Installing Org Users Only

To install Org Users Only, first, go to the Apps menu on the desired site. Then, under the Admin menu, click on Find new apps. Next, search for Org Users Only, select it, and proceed with the installation.

Features/Usage

This app synchronises users from a provided Atlassian organisation to Assets.

Users are pulled from the organisation and compared with available data about the user in Assets. The app retrieves a list of users from the organisation and compares them with the user’s Asset object in the selected Assets schema and object type. The user is matched by their account ID. If an Asset object cannot be found for the user, one is created. If any data point in the Asset object does not match the data from the Organisations API, the Asset object is updated to ensure data is kept up to date.

Sync Users to Assets

When viewing the app, the user sees a form with four fields.

Screenshot 2025-03-05 102015.png

Provide the Organisation ID for the organisation to retrieve users from and an API key created for this organisation.

The Assets schema and object type the app will sync the users to can be specified in the dropdown. These two fields are optional and will default to a schema called People and an Object called People type.

After entering the Organisation ID and API key, click the Sync button to initiate the user synchronization process. Progress logs will be displayed on the page, detailing any issues encountered for each user throughout the syncing process.

After the sync, a summary will be presented, indicating the number of user Asset objects that were created or updated, objects that remained unchanged (indicating data is current), and those that encountered errors.

The data Synchronised 

User data

  • The user's account name (stored in the Name attribute)

  • The user's email address (stored in the Email attribute)

  • The user's account Id (stored in the User and Atlassian ID attribute)

  • The user's status (stored in the Status Attribute)

User statuses

  • Active (the user is an active user of the site)

  • Unverified (the user has not logged in)

  • Inactive (the user is no longer a user of the site)

Sync Logs

As the sync progresses, logs are shown in a table below the form. These logs show information such as the number of users found in the organisation, any Asset attributes that needed to be created that were found to be missing from the selected schema, any errors with syncing a user and a final summary of changes made to the Assets objects.

A progress bar also shows how many users have been synced so far. 

image-20250210-043345.pngimage-20250210-043425.png

 

Status Configuration

The user’s status is stored in the Status attribute. It is possible that Assets in the installed instance may not have the listed status. This could potentially result in an error syncing a user.
One limitation of Forge is its inability to retrieve a list of available statuses in Assets. To address this issue, users can utilize a configuration form, which can be accessed by clicking on the cog icon ⚙️ within the app.

image-20250305-001926.pngimage-20250110-053642.png

This configuration form provides a link to the available statuses in the global Assets configuration for the installed instance, as well as input fields for each user status. The user is able to review the statuses available in their Assets and copy a relevant status into the field. The app will then use this status, replacing the original user status value.

Alternatively, users can create relevant statuses that can then be used through the link.

  

Known Limitations