Map custom attributes in Microsoft Entra ID

Map extra user attributes from Microsoft Entra ID to Perk over SCIM, with the full target-attribute directory and steps to add and customize mappings.

Use this guide to map extra user attributes from Microsoft Entra ID (previously named Azure Active Directory or Azure AD) to Perk. For the full attribute schema, see the SCIM user model reference.

Prerequisites

Before you start, make sure you have:

Attribute mapping directory

The table below lists the Perk target attributes you can map from Microsoft Entra ID. Required attributes are marked.

Perk target attributeNotesType
userName (required)User name.String
externalIdExternal ID.String
active (required)Active status.Boolean
name.honorificPrefixPrefix.String
name.familyName (required)Family name.String
name.givenName (required)Given name.String
name.middleNameMiddle name.String
preferredLanguagePreferred language.String
localeA valid language tag as defined in RFC 5646. Perk uses it to deduce the currency, date and time format, and language when it creates the user, if those values aren't otherwise set.String
phoneNumbers[type eq "work"].valuePhone number. Use the format + {country_code} {phone_number}.String
titleTitle.String
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenterCost object. If a cost object with the given name isn't found, Perk creates it.String
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumberEmployee number.String
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:managerLine manager.Reference
urn:ietf:params:scim:schemas:extension:travelperk:2.0:User:genderGender.String
urn:ietf:params:scim:schemas:extension:travelperk:2.0:User:dateOfBirthDate of birth.String
urn:ietf:params:scim:schemas:extension:travelperk:2.0:User:invoiceProfilesPayment profiles.Array
urn:ietf:params:scim:schemas:extension:travelperk:2.0:User:emergencyContact.nameEmergency contact name.String
urn:ietf:params:scim:schemas:extension:travelperk:2.0:User:emergencyContact.phoneEmergency contact phone number.String
urn:ietf:params:scim:schemas:extension:travelperk:2.0:User:travelPolicyTravel policy.String
urn:ietf:params:scim:schemas:extension:travelperk:2.0:User:uniqueIdUnique ID.String
urn:ietf:params:scim:schemas:extension:expense:2.0:User:policyIdExpense policy ID.String
urn:ietf:params:scim:schemas:extension:expense:2.0:User:creditorCreditor.String
urn:ietf:params:scim:schemas:extension:expense:2.0:User:legalEntityIdLegal entity ID.String
urn:ietf:params:scim:schemas:extension:expense:2.0:User:approvalThresholdApproval threshold.Decimal
urn:ietf:params:scim:schemas:extension:expense:2.0:User:ignoreManagerInRequestsIgnore manager in requests.Boolean

Custom fields

Custom fields are account-specific attributes defined in Settings > Cost management > Custom fields. Unlike the attributes in the Supported attributes table, the target attribute path is unique to your account and must be constructed before you can map them in Entra ID.

The target attribute for each custom field follows this pattern:

urn:ietf:params:scim:schemas:extension:perkcustomfields:2.0:User:cf_{slug}_{uuid}

Where {slug} is the field name lowercased with non-alphanumeric characters replaced by underscores, and {uuid} is the field's UUID in Perk. To find the UUID, open the field in Perk (Settings > Cost management > Custom fields) — it appears in the URL:

https://app.perk.com/account/custom-fields/{uuid}

Because Microsoft Entra ID doesn't discover account-specific custom fields automatically, you need to register each one manually before mapping it. Follow the steps in Add target attributes manually below, using:

  • Name: the full target attribute path (e.g. urn:ietf:params:scim:schemas:extension:perkcustomfields:2.0:User:cf_brand_138bcf1e-ce81-4eb6-b5f2-d62f8c817ac7)
  • Type: String

Once registered, map it using the standard steps in Customize attribute mappings.

Custom field attribute errors

Unknown attribute keys are silently ignored. If the target attribute doesn't match a known custom field, the user is still created or updated, but the custom field value is not written. Double-check the UUID against your field definitions if values are not appearing.

For a full walkthrough including payload examples, see Provision custom fields via SCIM.

Customize attribute mappings

To map a Perk attribute to a Microsoft Entra ID source attribute, follow these steps:

  1. Go to your Perk app in Microsoft Entra ID.
  2. Go to Provisioning > Settings > Mapping and select Provision Microsoft Entra ID Users.
  3. Review the list of attribute mappings that appears.
The Microsoft Entra ID attribute mappings list showing the Provision Microsoft Entra ID Users option.

To add a new mapping:

  1. Select Add new mapping at the bottom-left of the screen.
  2. Select the Source attribute from Microsoft Entra ID.
  3. Select the Target attribute from Perk. For the full list, see the Attribute mapping directory above.

For example, the screenshot below maps Microsoft Entra ID's companyName source attribute to the target attribute urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenter, which is the cost object in Perk.

The Microsoft Entra ID Add Attribute Mapping dialog, with companyName mapped to the cost center attribute.

To update an existing mapping:

  1. Select Delete to remove the existing mapping.
  2. Add the new mapping using the steps above.
  3. Select Save to apply your changes.
⚠️

Warning

Microsoft Entra ID doesn't create travel policies or payment profiles for you. Create them in Perk before you run a sync, or the attribute values won't map correctly.

Troubleshooting: add target attributes by hand

Sometimes the app instance in Microsoft Entra ID falls out of sync with the latest SCIM schema from Perk. When this happens, some target attributes are missing from the mapping list. You can register the missing attributes by hand:

  1. Go to Microsoft Azure. The URL must end with forceSchemaEditorEnabled=true to allow these changes.
  2. Open Enterprise Applications and select the existing TravelPerk app.
  3. Go to Provisioning > Edit Provisioning > Mappings > Provision Microsoft Entra ID Users.
  4. Scroll to the bottom and select Show advanced options > Edit attribute list for Perk.
The Microsoft Entra ID Edit attribute list panel, where you add new attributes.
  1. Add a new attribute at the bottom of the list, using the name and type from the Attribute mapping directory above. Leave all other fields empty.
  2. Select Save.
  3. Map the new attribute using the Customize attribute mappings steps above.

Next steps



Did this page help you?