How to get users Birthday using graph api ?

Question

How to get users Birthday using graph api ?

Shahab Matapour 25

Hi guys,

I tried to get users birthday using graph api call, in graph explorer I tried https://graph.microsoft.com/v1.0/users?$select=displayName,mail,id,jobTitle,birthday and https://graph.microsoft.com/v1.0/users?$select=displayName,mail,id,jobTitle,SPS-Birthday but it doesn't work. Through spo admin 'userprofile' section I added a refineable string and maped it to 'SPS-Birthday' then the status of crawled and Idled but also doesn't work.

Please guide me how to get users birthday property using graph call.

Thanks in advance.

Accepted answer

0 additional answers

Your answer

Answer 1

Harpreet Singh Matharoo 8,396 Microsoft Employee Moderator

Hello @Shahab Matapour

The birthday property is not a standard property of the User resource in the Microsoft Graph API. It's also not a custom property that can be added to the SharePoint User Profile Service and then retrieved via the Graph API.

One option to achieve this is to store the birthday as a custom extension property on the Azure Active Directory (AAD) user object, and then retrieve it using the Graph API. Here are the steps to do this:

1. Use the Azure AD PowerShell module to create a custom extension property on the AAD user object:

Connect-AzureAD
$extensionName = "birthday"
$extension = New-AzureADUserExtension -Name $extensionName -DataType DateTime

Use the Graph API to set the custom extension property on a user:

PATCH https://graph.microsoft.com/v1.0/users/{user-id}
{
    "extensions": [
        {
            "@odata.type": "#microsoft.graph.openTypeExtension",
            "extensionName": "birthday",
            "birthday": {
                "dateTime": "2000-01-01T00:00:00Z",
                "timeZone": "UTC"
            }
        }
    ]
}

Use the Graph API to retrieve the custom extension property on a user:

GET https://graph.microsoft.com/v1.0/users/{user-id}?$select=displayName,mail,id,jobTitle,extensions

Note that, you will need to have the appropriate permissions to create, update and read the custom extension property on the AAD user object. You may also need to wait for a full user profile sync to happen for the custom property to be indexed properly.

Another option is to store the information in another service like Sharepoint or OneNote and then access it via the Graph API.

I hope this helps.

Please "Accept the answer" if the information helped you. This will help us and others in the community as well.

Shahab Matapour 25 Reputation points

2023-01-16T11:37:56.4333333+00:00

Hi @Harpreet Singh Matharoo ,

Thanks for your guide, I tried your solution and encounter with below error, could you please help me how to add custom extension property to AAD user object ?
Harpreet Singh Matharoo 8,396 Reputation points Microsoft Employee Moderator

2023-01-16T11:57:27.3+00:00
Hello @Shahab Matapour

New-AzureADUserExtension seems to have stopped working. You can also use an app registration for the purpose of implementing custom extension attributes.

Go to the Azure AD Portal, click Azure Active Directory and App registrations.

Click New registration, give the app a name like IAM Custom Extension Attributes, keep the other settings default and click Register.

Make a note of the app registration’s Object ID as we need this value when creating the extension attributes.

Custom extension attributes can be of the following types: Binary, Boolean (true/false), DateTime (2021-10-16T18:01:29), String (“Some Value”), Integer (12345) and LargeInteger.

Go to Graph Explorer.

Do a GET request to resource Uri https://graph.microsoft.com/v1.0/applications/{App registration Object ID} - replace {App registration Object ID} with the actual objectId of the app registration created earlier, and click Run query. You should get the app registration returned in the response.

GET https://graph.microsoft.com/v1.0/applications/d74460c9-27d2-4dc9-bcba-49087063c360

Now change method to POST with resource Uri https://graph.microsoft.com/v1.0/applications/{App registration Object ID} and add Request body as shown below (in this example we create a String attribute named Birthday for User and Group objects):

POST https://graph.microsoft.com/v1.0/applications/d74460c9-27d2-4dc9-bcba-49087063c360/extensionProperties { "name": "Birthday", "dataType": "DateTime", "targetObjects": [ "User" "Group" ] }

Make a note of the name value in the response, as this is the full attribute name that can now be populated with a string value on User objects in Azure AD. The attribute name consists of extension_ + Application (client) ID + attribute name, which in this example is extension_cde0e9a5d3f44a81b81097334dbb9f66_Birthday.

I hope this resolves your ask.
Shahab Matapour 25 Reputation points

2023-01-16T12:37:51.5033333+00:00

Hello @Harpreet Singh Matharoo ,

Thanks for your comprehensive explanations, my problem solved by your help.
Daan Proost 0 Reputation points

2023-05-26T11:55:26.73+00:00

I tried this but get '405 - Method not allowed' even though I have my account consent on all permissions. What am I doing wrong?
Danny Zollner 10,801 Reputation points Microsoft Employee Moderator

2023-05-26T17:09:54.0066667+00:00

@Daan Proost I'd suggest creating your own post rather than asking in the comments on this one.

Also for anyone reading this in the future - Azure AD Custom Security Attributes are now in public preview and allow you to create schema extension attributes that can can be restricted from being accessed unless the correct permission/authorization is assigned to the object reading the data. I'd suggest going with that approach for attributes like this, if you were to store them in AAD at all, since DOB may not be something that should be readable to a broad audience.

https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/custom-security-attributes-overview

Share via

How to get users Birthday using graph api ?

0 additional answers

Your answer