Add Custom Attributes in Azure Active Directory Using Microsoft Graph

This article covers step-by-step instructions for creating and managing custom user attributes, enabling you to tailor your directory to meet specific organizational needs.

Prerequisites

1. Azure Subscription: You need an Azure account. You can sign up for a free account if you don’t have one.
2. Microsoft Graph Explorer: Access Microsoft Graph Explorer.

Step 1. Create an App Registration

To use Microsoft Graph, you must register an application in Azure AD.

1. Navigate to Azure Portal: Go to the Azure portal.
2. Select Azure Active Directory: In the left-hand menu, click on "Azure Active Directory."
3. Register a New Application
   • Click on "App registrations."
   • Click on "+ New registration."
   • Enter a name for your application (e.g., "CustomAttributesApp").
   • Select the supported account types (e.g., "Accounts in this organizational directory only").
   • Click "Register."
4. Copy Application (Client) ID: After registration, note the Application (client) ID from the application overview page. You'll need this ID later.

Step 2. Create a Custom Extension Attribute

Now that we have an app registration let's create a custom extension attribute.

1. Open Graph Explorer: Access Graph Explorer.
2. Authenticate: Click on "Sign in to Graph Explorer" to authenticate with your Azure account.
3. GET Request for Application
   • Set the request method to GET.
   • Enter the following resource URI, replacing {App registration Object ID} with your Application ID:
   • Code: Get https://graph.microsoft.com/v1.0/applications/{App registration Object ID}
   • Click "Run Query."
4. Create Extension Attribute
   • Change the method to POST and enter the following resource URI
   • Code: POST https://graph.microsoft.com/v1.0/applications/{App registration Object ID}/extensionProperties
   • Add the request body to create a custom attribute (e.g., "Birthday")

     {
       "name": "Birthday",
       "dataType": "string",
       "targetObjects": [
         "User",
         "Group"
       ]
     }

   • Click "Run Query."
5. Note the Extension Attribute Name: The response will include the full attribute name in the format.
   For example
6. Code: extension_cde0e9a5d3f44a81b81097334dbb9f66_Birthday

Step 3. Populate the Custom Extension Attribute on a User

Next, we’ll populate this attribute for a specific user.

1. Find User ID
   • To find users in Azure AD, navigate back to the Azure portal.
   • Click on "Users" under Azure Active Directory.
   • Select a user to view their details. You can note their Object ID or User Principal Name (UPN).
2. Patch User with Extension Attribute
   • In Graph Explorer, set the method to PATCH.
   • Enter the resource URI for the user:
   • Code: PATCH https://graph.microsoft.com/v1.0/users/{user objectId or upn}
   • Add the request body to set the extension attribute value.
   • Code: { "extension_cde0e9a5d3f44a81b81097334dbb9f66_Birthday": "2000-11-05T11:40:09Z" }
   • Click "Run Query." If you get an HTTP 204 response, the patch is successful.

Step 4. Retrieve Custom Extension Attribute on a User

Now, let's retrieve the custom extension attribute to confirm it has been populated.

Get User Details

1. Set the method to GET in Graph Explorer.
2. Enter the resource URI.
3. Code: GET https://graph.microsoft.com/v1.0/users/{user objectId or upn}?$select=id,displayName,userPrincipalName,extension_cde0e9a5d3f44a81b81097334dbb9f66_Birthday

or

1. Code: GET https://graph.microsoft.com/beta/users/{user objectId or upn}
2. Click "Run Query." You should see the user details along with the custom attribute.

Output

Note on Permissions

• If you encounter any errors related to permissions while using Graph Explorer, ensure that you check the "Modify Permissions" section. In the status column, look at the image below. It is all okay. If you see a "Consent" button in blue, click on it to grant the necessary permissions. This should resolve your issue.
• Additionally, if you cannot find certain features or attributes in the v1.0 version, try using the beta version of Microsoft Graph Explorer, as it may have the functionality you need.

Conclusion

You've successfully created a custom extension attribute in Azure AD and populated it with data using Microsoft Graph. This feature allows you to store additional information that can be useful for your organization's needs.

Thank you for reading!

If you have any questions or need further assistance, feel free to leave a comment below.