Skip to main content
Eptura Knowledge Center

Custom Attributes Mapping for Microsoft Entra

This describes how to add user custom attributes to Microsoft Entra ID. There are 2 ways this can be completed:

Pre-requisites

Make sure you have the following privileges:

  • Microsoft Entra Admin Center login requires you to be at least a User Administrator | Microsoft
  • Graph API consent permission.
  • Microsoft Azure Portal login.

Option 1 - Using Microsoft Entra Admin Center


  1. Sign in to the Microsoft Entra Admin Center, https://entra.microsoft.com/.
  2. From the menu, navigate to Identity > External Identities > Overview.
  3. From the sub-menu, select Custom user attributes and the available user attributes are listed.

clipboard_ef5015474a8ff28aed6d79e461384ad46.png

You can add the custom attribute here.

  1. Click the +Add button and the Add an attribute form displays.

clipboard_e86184075166a92dfe0c54409bd4e5db7.png

  1. In the Name field, enter the name for the custom attribute.
  2. From the Data Type drop-down, select a data type, such as String, Boolean, or Integer.
  3. In the the Description field, enter a short description of the custom attribute. This is for internal use and isn't visible to the user.
  4. Click the Create button.

Option 2 - Using Graph API


You can add an attribute and update custom attribute to the user from Graph API. 

  1. Navigate to Graph Explorer | Microsoft Graph APIshttps://developer.microsoft.com/en-us/graph/graph-explorer
  2. Click the API Explorer to displays the available resources.

clipboard_e7517c4f279669be27cc8528fb205494e.png

  1. From the Resources Available navigate to applications>{application-id}>extensionProperties
  2. Click POST.

clipboard_e28182f0d727c8596512280a244ffb336.png

The {applicaition-id} used in the post request URL can be fetched:

  1. Navigate to the Azure Portal.
  2. Select the Microsoft Entra ID resource.
  3. From the left menu, navigate to Manage > App registrations.
  4. Select the SCIM Application.
  5. From the menu, select Overview.
  6. Then in the Overview screen for Essentials copy the Object ID.
  7. Update the custom attribute value for the user.

clipboard_e4afaa83626838309266e3dd4d0edc544.png

API Request Body

{
    "name": "{name of attribute}",
    "dataType": "{data type of attribute}",
    "targetObjects": [
        "User"
    ]
}

 

The custom attribute created above is now updated for a particular user. 

  1. Navigate to the Sample Queries tab.
  2. Select Users > PATCH (update user) API.
  3. Update the value by running the above API.

clipboard_e324c42ef39a7f99104cfe3d5ba50ac1d.png

The {id} used in the patch request URL can fetched: 

  1. Navigate to the Azure Portal.
  2. Select Microsoft Entra ID resource
  3. From the menu, navigate to Manage > Users.
  4. Select the User.
  5. In the Overview copy the Object ID / User principal name.

clipboard_e68726d3cbb5143dd7015d3e817fb9209.png

API Request Body

{
    "{name of attribute}": "{value}"
}

Map Custom Attributes with SCIM API

  1. Navigate to the Azure Portal.
  2. Go to a Microsoft Entra ID resource.
  3. From the menu, navigate to Manage > Enterprise Applications.
  4. Select the SCIM Application.
  5. From the menu, navigate to Manage > Provisioning.
  6. Go to Manage Provisioning > Edit Attribute Mapping.
  7. Select Mappings.
  8. Click Provision Microsoft Entra ID Users.
  9. Check the Show advanced options check box.

clipboard_e75c543382280ac318bc20544a4f7afde.png

  1. Click the Edit attribute list for customappsso.
  2. Add target attribute and save.
S. No. Attribute Name for Microsoft Entra Id Target Data Type

1

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager

Reference

2

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber

string

3

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization

string

4

urn:ietf:params:scim:schemas:extension:customextensionname:2.0:User:usageLocation

string

6

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenter

string

7

urn:ietf:params:scim:schemas:extension:customextensionname:2.0:User:group

string

8

urn:ietf:params:scim:schemas:extension:customextensionname:2.0:User:floor

string

10

urn:ietf:params:scim:schemas:extension:customextensionname:2.0:User:phoneExtension

string

11

urn:ietf:params:scim:schemas:extension:customextensionname:2.0:User:workMode

string

12

urn:ietf:params:scim:schemas:extension:customextensionname:2.0:User:image

string

For example

clipboard_ecfd3f267654baec9f0a63140e1e08259.png

  1. After the attributes are created, click the Add New Mapping, to map the custom attribute. 

clipboard_e4ee29f02df6c69839f3b412e60a2de8b.png

  1. From the Source attribute drop-down, select the source which is the attribute name added from Microsoft Entra Admin Center/Graph API. 
  2. From the Target attribute drop-down, select target attributes that are set in the above step (Map Custom Attributes with SCIM API).
  3. Click the OK button.
  4. Click the Save button.

Test Custom attribute mapping

  1. Navigate to the Azure Portal.
  2. Go to a Microsoft Entra ID resource.
  3. From the menu, navigate to Manage > Enterprise Applications.
  4. Select the SCIM Application.
  5. From the menu, navigate to Manage > Provisioning.
  6. From the menu, select Provision on Demand.
  7. In the Select a user or group field, search for the user and the select the user name.
  8. Click the Provision button.

clipboard_e2e2ed09b329f729ef7c7ac00fac9098b.png