Graph API 常见查询
本主题显示可用于 Azure AD Graph API 的常见查询。 有关查询 Graph 时支持的操作的详细信息,请参阅“Azure AD Graph 中支持的查询、筛选器和分页选项”。
重要
强烈建议使用 Microsoft Graph 代替 Azure AD Graph API 来访问 Azure Active Directory 资源。现在我们的开发工作将重点集中在 Microsoft Graph 上,没有计划对 Azure AD Graph API 进行进一步的改进。Azure AD Graph API 仍适用的方案数量非常有限;有关详细信息,请参阅 Office 开发人员中心中的博客文章 Microsoft Graph 或 Azure AD Graph。
寻址
下面的所有查询全都使用某一域名对租户进行寻址。 你可以使用租户已注册的域名称之一、租户 ID (GUID) 或 MyOrganization
别名(用于委托访问)替换 contoso.com。 有关对租户进行寻址的其他方法,请参阅“对 Graph API 中的实体和操作进行寻址”。
查询顶层资源
以下常见查询使用 contoso.com 作为示例租户,演示如何通过 Graph API 访问顶层资源。 请注意,要运行针对租户的查询,将需要授权标头,该标头包含接收自 Azure AD 的有效持有者令牌。
顶层资源 | 查询结果 | URI(对于 contoso.com) |
---|---|---|
顶层资源 | 为目录服务返回顶层资源的 URI 列表(也在下面列出) | https://graph.windows.net/contoso.com?api-version=1.6 |
公司信息 | 返回公司信息 | https://graph.windows.net/contoso.com/tenantDetails?api-version=1.6 |
联系人 | 返回组织联系人信息 | https://graph.windows.net/contoso.com/contacts?api-version=1.6 |
Users | 返回用户信息 | https://graph.windows.net/contoso.com/users?api-version=1.6 |
组 | 返回组数据 | https://graph.windows.net/contoso.com/groups?api-version=1.6 |
目录角色 | 返回租户中所有已激活的目录角色 | https://graph.windows.net/contoso.com/roles?api-version=1.6 |
SubscribedSkus | 返回租户的订阅 | https://graph.windows.net/contoso.com/subscribedSkus?api-version=1.6 |
目录元数据 | 返回描述数据模型的服务元数据文档(即,目录资源的结构和组织) | https://graph.windows.net/contoso.com/$metadata?api-version=1.6 |
查询操作
下表展示一些将 contoso.com 用作示例租户的示例 Graph API 查询。
查询操作 | URI(对于 contoso.com) |
---|---|
列出所有用户和组 | https://graph.windows.net/contoso.com/users?api-version=1.6 https://graph.windows.net/contoso.com/groups?api-version=1.6 |
通过指定 objectId 或 userPrincipalName 检索单独用户 | https://graph.windows.net/contoso.com/users/d1f67a6c-02c9-4fe5-81fb-58160ce24fe5?api-version=1.6 https://graph.windows.net/contoso.com/users/admin@contoso.com?api-version=1.6 |
请求并筛选 displayName 等于“Jon Doe”的用户 | https://graph.windows.net/contoso.com/Users?$filter=displayName eq 'Jon Doe'&api-version=1.6 |
请求并筛选 firstName 等于“Jon”的特定用户 | https://graph.windows.net/contoso.com/users?$filter=givenName eq 'Jon'&api-version=1.6 |
筛选 givenName 和 surname 值。 | https://graph.windows.net/contoso.com/users?$filter=givenName eq 'Jon' and surname eq 'Doe'&api-version=1.6 |
通过指定 objectId 检索单个组 | https://graph.windows.net/contoso.com/groups/06790a81-0382-434c-b40e-216fa41bda21?api-version=1.6 |
检索用户的经理 | https://graph.windows.net/contoso.com/users/John.Smith@contoso.com/manager?api-version=1.6 |
检索用户的直接下属列表 | https://graph.windows.net/contoso.com/users/3c4a09b0-a7b6-444e-9702-96983635a66e/directReports?api-version=1.6 |
检索到用户的直接下属的链接列表 | https://graph.windows.net/contoso.com/users/3c4a09b0-a7b6-444e-9702-96983635a66e/$links/directReports?api-version=1.6 |
检索某一组的成员身份列表 | https://graph.windows.net/contoso.com/groups/3f575eef-bb04-44a5-a9af-eee9f547e3f9/members?api-version=1.6 |
检索到某一组的成员的链接列表。 | https://graph.windows.net/contoso.com/groups/3f575eef-bb04-44a5-a9af-eee9f547e3f9/$links/members?api-version=1.6 |
检索用户的组成员身份(不可传递) | https://graph.windows.net/contoso.com/users/ee6308f6-646a-4845-a4e1-57ac96ccc0c8/memberOf?api-version=1.6 |
检索该用户是其成员的组的列表(不可传递) | https://graph.windows.net/contoso.com/users/ee6308f6-646a-4845-a4e1-57ac96ccc0c8/$links/memberOf?api-version=1.6 |
请求并筛选 displayName >= "az" 和 <= "dz" 的组 | https://graph.windows.net/contoso.com/groups?$filter=displayName ge 'az' and displayName le 'dz'&api-version=1.6 |
注意: 查询字符串中的空格应先进行 URL 编码,然而才能发送请求。 例如,对下列查询字符串 https://graph.windows.net/contoso.com/Users?$filter=displayName eq 'Jon Doe'&api-version=1.6
进行 URL 编码后应为: https://graph.windows.net/contoso.com/Users?$filter=displayName%20eq%20'Jon%20Doe'&api-version=1.6
。