Sync Agent Custom Fields from Microsoft Entra ID
This guide provides step-by-step instructions on synchronizing agent custom fields in BoldDesk with user attributes from Microsoft Entra ID.
Supported custom fields
The following table summarizes the agent custom field types in BoldDesk that can be synced from a user attribute in Microsoft Entra ID.
| BoldDesk Custom field type | Microsoft Entra ID attribute type | Comments |
|---|---|---|
| Textbox (single-line) | String | |
| Textbox (multi-line) | String | |
| Checkbox | Boolean | |
| Yes/No | Boolean | |
| Date | Date Time | Consider only the date value from the Microsoft Entra ID input. |
| Date Time | Date Time | |
| Numeric | Integer | |
| Decimal | String | Convert the given string to decimal. |
| Dropdown (single-select) | String | Based on the text value, retrieve the ID and save it in the database. |
| Regex | String | Regex validation will be handled here before saving the string. |
| URL | String | URL validation will be handled before saving the string. |
Steps to Sync Custom Fields from Microsoft Entra ID to BoldDesk
To sync custom fields from Microsoft Entra ID to BoldDesk, follow the given steps:
- Access User Fields in BoldDesk
Go to Admin > Fields and Forms in the left menu and then click User Fields.
-
Then, select the Agent Form.
-
Select the custom field you wish to sync and click Copy to clipboard button to copy the API name of the custom agent field.
-
Configure Attribute Mapping in Microsoft Entra ID
- In Azure Active Directory, go to Enterprise Applications → BoldDesk App.
- Click Provisioning → Edit Provisioning.
-
In the Mappings section, click Provision Azure Active Directory Users.
-
Scroll down the page and select Show advanced options. Click Edit attribute list for BoldDesk app.
-
Add a new item at the bottom of the Attribute List table. Combine “urn:ietf:params:scim:schemas:extension:bolddeskAgentCustomFields:2.0:User:<API_Name>” with the API Name from Step 3.
Example: urn:ietf:params:scim:schemas:extension:bolddeskAgentCustomFields:2.0:User: cf_text_box -
Refer to the table above to select the correct Microsoft Entra ID attribute type based on the BoldDesk custom field you are syncing.
-
For types such as string, integer, datetime, or Boolean, leave the remaining columns blank.
-
Click Save to return to the attribute mapping page. At the bottom of the Attribute Mappings table, click Add New Mapping.
-
In the Edit Attribute form, enter the following information:
1. Mapping type: Direct
2. Source attribute: Choose the Microsoft Entra ID user attribute to be mapped to the BoldDesk agent custom field, e.g., City.
3. Default value: Leave blank.
4. Target attribute: Select the attribute created in step 7.
5. Match objects using this attribute: No
6. Apply this mapping: Always. -
Save the new attribute and confirm completion of the attribute mapping.
- For string, integer, datetime, or Boolean types, leave additional columns blank.
- Ensure the API Name matches the BoldDesk custom field exactly.
- Changes take effect during the next provisioning cycle.
Frequently Asked Questions (FAQ)
Q1: Which BoldDesk fields can be synced with Entra ID?
Text Box, Number, Date Picker, and Checkbox fields.
Q2: Do I need to enable SCIM provisioning?
Yes. SCIM provisioning must be active for attribute mapping to work.
Q3: Can I sync multiple custom fields?
Yes. Repeat the steps for each custom field you want to map.
Q4: What happens if the API name is incorrect?
The mapping will fail, and the field will not sync.
Q5: How often does the sync occur?
Sync runs based on the provisioning schedule configured in Entra ID.
