Get users via MS Graph API using $search query option on directory extension properties

Question

Hi,

I am trying to use $search query parameter to restrict the results of a MS Graph API 'Get Users' request to match a search criterion using directory extension properties, but I am not able to send a request due to an error (see first image below).

Reading documentation for Users API I am not able to see, if $search is supported or unsupported with directory extension properties.

Initially I wanted to use $filter query parameter with 'contains' operator, because I need to filter/search on a substring of a value stored in a directory extension property, but it is not supported by Users API.

$search using directory extension properties - FAILS

Request URL:
https://graph.microsoft.com/v1.0/users?$search="extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType:teacher"&$select=displayName

Result:

$search using default AAD properties - OK

Request URL:
https://graph.microsoft.com/v1.0/users?$search="displayName:alex"&$select=displayName

Result:

$filter using directory extension properties - OK

I am able to use directory extension properties in $filter query parameter using 'eq' operator, but I need to use 'contains' operator, which is not supported by Users API.

Request URL:
https://graph.microsoft.com/v1.0/users?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType eq 'teacher'&$select=displayName

Result:

Answer 1

Hello @Igor Demjanov

Thanks for reaching out!

As per the user resource type documentation, Directory and schema extensions and their associated data are returned only on $select query parameter; whereas Open extensions and their associated data are returned only on $expand query parameter.

Refer these for more info:
https://learn.microsoft.com/en-us/graph/extensibility-overview?tabs=http
https://learn.microsoft.com/en-us/graph/extensibility-overview?tabs=http#directory-azure-ad-extensions
https://learn.microsoft.com/en-us/graph/extensibility-overview?tabs=http#retrieve-a-directory-extension-property

Hope this helps.

If the answer is helpful, please click Accept Answer and kindly upvote. If you have any further questions about this answer, please click Comment.

Answer 2

Hi @Igor Demjanov

As you can see, the extended attributes of Azure AD B2C users do not support filtering with the $search parameter. The best option is still to filter with the $filter parameter, and you don't need to provide the ConsistencyLevel: eventual request header for that request, as this is not an advanced query.

---

If the answer is helpful, please click "Accept Answer" and kindly upvote it. If you have extra questions about this answer, please click "Comment".
Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.