App page
Azure AD Attributes for Jira
Azure AD Attributes for Jira
Documentation
FAQ
Release notes
Last updated Oct 28, 2024

Mapping Azure Active Directory data to a custom field

Learn how to configure a custom field in order to display information from Azure Active Directory

Warning

Remember to always add the custom field to both the Create issue and the Edit issue screen. Otherwise, the synchronization won’t work.

Apart from global Jira settings, you can also do this in the issue configuration, which is located under the Issue Details View.
You’ll find a video tutorial in the further part of this chapter.

Start mapping

Note

Synchronization works globally, meaning it’ll appear in any project containing the selected custom field when synchronization is triggered.

Here is how to start mapping to a custom field:

Steps

  1. Open the global Settings from the top right menu.
  2. Select Apps from the drop down list.
  3. Select Synchronization from the left hand side menu.
  4. Click Map new field.
Azure AD Attributes for Jira - Mapping Azure AD data to a custom field
Azure AD Attributes for Jira - Mapping Azure AD data to a custom field

Result

You will be brought to a configuration screen where you can choose the custom field type, select Azure Active Directory attributes to be mapped, and decide whose data should be displayed.

Select field

The first drop-down menu lets you choose a custom field to display Azure Active Directory information. You can either select an existing custom field or create a new one.

Use an existing custom field

Existing custom fields of the types listed below will work with Azure AD Attributes Sync for Jira:

  • Text Field (multi-line)
  • Text Field (single-line)
  • Text Field (read-only)
  • User Picker (single user)
  • User Picker (multiple users)
  • Select List (single choice)
Note

Select List (single choice) field type supports attributes listed below:

  • Business phone
  • City
  • Company name
  • Country
  • Department
  • Display name
  • Employee ID
  • First name
  • Job title
  • Last name
  • Mail
  • Manager
  • Mobile phone
  • Office location
  • Street address
    Select List (single choice) also supports custom user attributes. Read more about them in the Custom user attributes chapter. To learn more about the types of available custom fields, see the Displaying Azure AD Data in a custom field chapter.

Steps

To choose an existing custom field:

  1. Expand the Select field options.
  2. Select the first tab, Existing fields.
  3. Search for the custom field you’d like to use.

Clicking on the selected custom field will save your choice.

Azure AD Attributes for Jira - Mapping Azure AD data to a custom field: Use an existing custom field
Azure AD Attributes for Jira - Mapping Azure AD data to a custom field: Use an existing custom field
Tip

If you choose the Select List (single choice) field type, you’ll see a toggle. If you enable it, each individual synchronization will add one option to the single select list based on the chosen attribute’s value from Azure AD.

Azure AD Attributes for Jira - Mapping Azure AD data to a custom field: Use a Select List (single choice)
Azure AD Attributes for Jira - Mapping Azure AD data to a custom field: Select list (single choice)

Create a new field

You can create a new custom field directly from the mapping screen.

Note

If you update the Azure AD permissions, new Jira custom fields will be available for mapping.

Steps

To create a new custom field:

  1. Expand the Select field options.

  2. Go to the second tab, Create new.

  3. Select the Custom field type. There are six types available:

    • Text Field (multi-line)
    • Text Field (single-line)
    • Text Field (read-only)
    • User Picker (single user)
    • User Picker (multiple users)
    • Select List (single choice)
  4. Give the custom field a name under the Field label.

  5. Add a description (optional).

  6. Click Create.

Azure AD Attributes for Jira - Mapping Azure AD data to a custom field: Create a new field
Azure AD Attributes for Jira - Mapping Azure AD data to a custom field: Create a new field

Select attributes

In the next step, you can choose the Azure Active Directory attributes that should be displayed in the custom field. You may select as many as you need.

Tip

If you’d like to display many attributes in one field, we recommend the Text Field (multi-line) field type. It allows you to render the data in an easy-to-read table.

Text Field (single-line) displays the data in one long line and separates different attributes with semicolons. This is why we only recommend this field type for displaying single attributes.

Learn more about Displaying Azure AD data in a custom field.

Note
The order of Azure Active Directory attributes in the Select attributes field determines their display order. You can reorder them using drag-and-drop.

Steps

To select Azure Active Directory attributes:

  1. Click Select attributes.
  2. Click on the arrow to expand the drop-down list.
  3. Select the attributes to be displayed in the custom field.
Azure AD Attributes for Jira - Mapping Azure AD data to a custom field: Select attributes
Azure AD Attributes for Jira - Mapping Azure AD data to a custom field: Select attributes

Select user

In the last configuration step, you can choose whose data will be displayed in the issue. You can only choose one user for one custom field.

Steps

To select a user whose attributes will be displayed in the custom field:

  1. Click Select user.
  2. Click on the arrow to expand the drop-down list.
  3. Select one of those three options:
  • Assignee
  • Reporter
  • User Picker (single user)
Jira Active Directory integration with Azure AD Attributes - Mapping Azure AD data to a custom field: Select user
Azure AD Attributes for Jira - Mapping Azure AD data to a custom field: Select user

Remember to save the settings:

Jira Active Directory integration with Azure AD Attributes - Mapping Azure AD data to a custom field: Save settings
Azure AD Attributes for Jira - Mapping Azure AD data to a custom field: Save settings

Result

You’ll see a success notification, and the mapping will be added to the list of mappings under its target view. To trigger a synchronization, create an issue or make an update on a chosen issue.

By choosing the Select list (single choice) custom field type and turning on the toggle, you’ll see an icon. The icon appears to inform you that a value from Azure AD is added to the single select list if it doesn’t already exist on it.

Jira Active Directory integration with Azure AD Attributes - Mapping Azure AD data to a custom field: Mapping success
Azure AD Attributes for Jira - Mapping Azure AD data to a custom field: Mapping success
Warning

After you turn on the toggle and synchronize for the first time, switching to a different user won’t clear the single select list; the first user’s attribute value will still appear on it.
If you change the synchronized attribute, values from previous synchronizations will also remain on the list.

Guick guide

Click through the live demo to see how to create a mapping to a new custom field.

Mapping options

You can edit custom fields, see issue screen configuration, or delete field mapping by clicking the three dots menu next to the selected mapping. Also, you can enable/disable the synchronization using the toggle button.

Jira Active Directory integration with Azure AD Attributes - Mapping Azure AD data to a custom field: Mapping options
Azure AD Attributes for Jira - Mapping Azure AD data to a custom field: Mapping options
Need help?

If you can’t find the answer you need in our documentation, raise a support request.