Export (0) Print
Expand All

Azure AD Graph API Common Queries

Updated: October 27, 2014

This topic lists common queries that can be used with the Azure AD Graph. For more information about supported operations when querying the Graph, see Supported Queries, Filters, and Paging Options in Azure AD Graph API.

The queries below all address the tenant using a domain name. You can replace contoso.com with one of your tenant’s registered domain names to successfully run the queries against your subscription. For information about other ways of addressing the tenant, see Addressing Entities and Operations in the Graph API.

The following common queries demonstrate how to access top-level resources in the Graph using contoso.com as the example tenant.

 

Top-Level Resources Query Results URI (for contoso.com)

Top-level resources

Returns URI list of the top-level resources for directory services (also listed below)

https://graph.windows.net/contoso.com?api-version=2013-04-05

Company information

Returns company information

https://graph.windows.net/contoso.com/tenantDetails?api-version=2013-04-05

Contacts

Returns contact information

https://graph.windows.net/contoso.com/contacts?api-version=2013-04-05

Users

Returns user information

https://graph.windows.net/contoso.com/users?api-version=2013-04-05

Groups

Returns group data

https://graph.windows.net/contoso.com/groups?api-version=2013-04-05

Roles

Returns all roles that have users or groups assigned to them

https://graph.windows.net/contoso.com/roles?api-version=2013-04-05

SubscribedSkus

Returns the tenant's subscriptions

https://graph.windows.net/contoso.com/subscribedSkus?api-version=2013-04-05

Directory metadata

Returns a Service Metadata Document that describes the data model (that is, structure and organization of directory resources)

https://graph.windows.net/contoso.com/$metadata?api-version=2013-04-05

The following common queries demonstrate how to perform a query operation in the Graph using contoso.com as the example tenant.

 

Query Operation URI (for contoso.com)

List all Users and Groups

https://graph.windows.net/contoso.com/users?api-version=2013-04-05

https://graph.windows.net/contoso.com/groups?api-version=2013-04-05

Retrieve individual User by specifying the objectId or userPrincipalName

https://graph.windows.net/contoso.com/users/d1f67a6c-02c9-4fe5-81fb-58160ce24fe5?api-version=2013-04-05

https://graph.windows.net/contoso.com/users/admin@contoso.com?api-version=2013-04-05

Request and Filter for a user with displayName equal to “Jon Doe”

https://graph.windows.net/contoso.com/Users?$filter=displayName eq 'Jon Doe'&api-version=2013-04-05

Request and Filter for specific users with firstName equal to “Jon”

https://graph.windows.net/contoso.com/users?$filter=givenName eq 'Jon'&api-version=2013-04-05

Filter for givenName and surname values.

https://graph.windows.net/contoso.com/users?$filter=givenName eq 'Jon' and surname eq 'Doe'&api-version=2013-04-05

Retrieve individual group by specifying the objectId

https://graph.windows.net/contoso.com/groups/06790a81-0382-434c-b40e-216fa41bda21?api-version=2013-04-05

Retrieve a user’s manager

https://graph.windows.net/contoso.com/users/John.Smith@contoso.com/manager?api-version=2013-04-05

Retrieve a user’s direct reports list

https://graph.windows.net/contoso.com/users/3c4a09b0-a7b6-444e-9702-96983635a66e/directReports?api-version=2013-04-05

Retrieve a list of links to a user’s direct reports

https://graph.windows.net/contoso.com/users/3c4a09b0-a7b6-444e-9702-96983635a66e/$links/directReports?api-version=2013-04-05

Retrieve membership list of a group

https://graph.windows.net/contoso.com/groups/3f575eef-bb04-44a5-a9af-eee9f547e3f9/members?api-version=2013-04-05

Retrieve a list of links to the members of a group.

https://graph.windows.net/contoso.com/groups/3f575eef-bb04-44a5-a9af-eee9f547e3f9/$links/members?api-version=2013-04-05

Retrieve a user’s group membership (not transitive)

https://graph.windows.net/contoso.com/users/ee6308f6-646a-4845-a4e1-57ac96ccc0c8/memberOf?api-version=2013-04-05

Retrieve a list of the groups that the user is a member of (not transitive)

https://graph.windows.net/contoso.com/users/ee6308f6-646a-4845-a4e1-57ac96ccc0c8/$links/memberOf?api-version=2013-04-05

Request and filter for groups with displayName => ‘az’ and <= ‘dz’

https://graph.windows.net/contoso.com/groups?$filter=displayName ge 'az' and displayName le 'dz'&api-version=2013-04-05

noteNote
White space in the query string should be URL-encoded before sending a request. For example, the following query string, https://graph.windows.net/contoso.com/Users?$filter=displayName eq 'Jon Doe'&api-version=2013-04-05, should be URL encoded as: https://graph.windows.net/contoso.com/Users?$filter=displayName%20eq%20'Jon%20Doe'&api-version=2013-04-05.

See Also

Show:
© 2014 Microsoft