Table of contents

Стандартные запросы API GraphGraph API Common Queries

Jimaco Brannian|Последнее обновление: 19.06.2018
|
2 Участники

В этой статье представлены некоторые стандартные запросы, которые можно выполнять при работе с API Graph Azure AD .This topic shows some common queries that can be performed with the Azure AD Graph API.Дополнительные сведения о операциях, поддерживаемых при запросах Graph см. в статье "Поддерживаемые запросы, фильтры и операции разбиения на страницы в API Graph Azure AD ".For more information about supported operations when querying the Graph, see Supported Queries, Filters, and Paging Options in Azure AD Graph API.

Важно

Для доступа к ресурсам Azure Active Directory мы настоятельно рекомендуем использовать Microsoft Graph вместо API Azure AD Graph.We strongly recommend that you use Microsoft Graph instead of Azure AD Graph API to access Azure Active Directory resources.Теперь наши усилия сфокусированы на разработке Microsoft Graph; дальнейшее продвижение API Azure AD Graph мы не планируем.Our development efforts are now concentrated on Microsoft Graph and no further enhancements are planned for Azure AD Graph API.Есть очень мало сценариев, в которых по-прежнему можно использовать API Azure AD Graph. Дополнительные сведения об этом см. в записи блога в центре разработчиков Office, где сравниваются решения Microsoft Graph и Azure AD Graph.There are a very limited number of scenarios for which Azure AD Graph API might still be appropriate; for more information, see the Microsoft Graph or the Azure AD Graph blog post in the Office Dev Center.

АдресацияAddressing

Все приведенные ниже запросы обращаются к клиенту по имени домена.The queries below all address the tenant using a domain name.Вы можете заменить contoso.com на одно из зарегистрированных доменных имен вашего клиента с идентификатором GUID или с псевдонимом MyOrganization вашего клиента (для делегированного доступа).You can replace contoso.com with one of your tenant’s registered domain names, with your tenant's ID (GUID), or with the MyOrganization alias (for delegated access).Сведения о других способах адресации клиента см. в статье "Адресация сущностей и операций в API Graph".For information about other ways of addressing the tenant, see Addressing Entities and Operations in the Graph API.

Запросы к ресурсам верхнего уровняQuerying Top-Level Resources

В следующих стандартных запросах показано, как получить доступ к ресурсам верхнего уровня в API Graph на примере клиента contoso.com.The following common queries demonstrate how to access top-level resources with the Graph API using contoso.com as the example tenant.Обратите внимание на то, что для выполнения запросов к клиенту потребуется заголовок авторизации, который содержит действительный токен носителя, полученный из Azure AD.Note that an Authorization header containing a valid bearer token received from Azure AD will be required to run queries against a tenant.

Ресурс верхнего уровняTop-Level ResourceРезультаты запросаQuery ResultsURI (для contoso.com)URI (for contoso.com)
Ресурсы верхнего уровняTop-level resourcesВозвращает список URI ресурсов верхнего уровня для службы каталогов (также перечисленных ниже)Returns URI list of the top-level resources for directory services (also listed below)https://graph.windows.net/contoso.com?api-version=1.6
Сведения об организацииCompany informationВозвращает сведения об организацииReturns company informationhttps://graph.windows.net/contoso.com/tenantDetails?api-version=1.6
"Контакты"ContactsВозвращает контактную информацию организацииReturns organizational contact informationhttps://graph.windows.net/contoso.com/contacts?api-version=1.6
UsersUsersВозвращает сведения о пользователеReturns user informationhttps://graph.windows.net/contoso.com/users?api-version=1.6
Groups (Группы)GroupsВозвращает данные о группеReturns group datahttps://graph.windows.net/contoso.com/groups?api-version=1.6
Роли каталогаDirectory RolesВозвращает все активированные роли каталога в клиентеReturns all activated directory roles in the tenanthttps://graph.windows.net/contoso.com/roles?api-version=1.6
SubscribedSkusSubscribedSkusВозвращает подписки клиентаReturns the tenant's subscriptionshttps://graph.windows.net/contoso.com/subscribedSkus?api-version=1.6
Метаданные каталога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=1.6

Операции запросовQuery Operations

В следующей таблице представлены некоторые примеры запросов API Graph, где в качестве примера используется клиент contoso.com.The following table shows some example Graph API queries using using contoso.com as the example tenant.

Операция запросаQuery OperationURI (для contoso.com)URI (for contoso.com)
Выводит список всех пользователей и группList all Users and Groupshttps://graph.windows.net/contoso.com/users?api-version=1.6

https://graph.windows.net/contoso.com/groups?api-version=1.6
Получение отдельных пользователей путем указания objectId или userPrincipalNameRetrieve individual User by specifying the objectId or userPrincipalNamehttps://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 DoeRequest 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=1.6
Запрос и фильтр для определенных пользователей, в котором firstName имеет значение JonRequest and Filter for specific users with firstName equal to “Jon”https://graph.windows.net/contoso.com/users?$filter=givenName eq 'Jon'&api-version=1.6
Фильтр по значениям givenName и фамилии.Filter for givenName and surname values.https://graph.windows.net/contoso.com/users?$filter=givenName eq 'Jon' and surname eq 'Doe'&api-version=1.6
Получение отдельной группы путем указания objectIdRetrieve individual group by specifying the objectIdhttps://graph.windows.net/contoso.com/groups/06790a81-0382-434c-b40e-216fa41bda21?api-version=1.6
Получение руководителя пользователяRetrieve a user’s managerhttps://graph.windows.net/contoso.com/users/John.Smith@contoso.com/manager?api-version=1.6
Получение списка непосредственных подчиненных пользователяRetrieve a user’s direct reports listhttps://graph.windows.net/contoso.com/users/3c4a09b0-a7b6-444e-9702-96983635a66e/directReports?api-version=1.6
Получение списка ссылок на непосредственных подчиненных пользователяRetrieve a list of links to a user’s direct reportshttps://graph.windows.net/contoso.com/users/3c4a09b0-a7b6-444e-9702-96983635a66e/$links/directReports?api-version=1.6
Получение списка членов группыRetrieve membership list of a grouphttps://graph.windows.net/contoso.com/groups/3f575eef-bb04-44a5-a9af-eee9f547e3f9/members?api-version=1.6
Получение списка ссылок на членов группы.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=1.6
Получение списка групп, членом (постоянным) которых является пользовательRetrieve a user’s group membership (not transitive)https://graph.windows.net/contoso.com/users/ee6308f6-646a-4845-a4e1-57ac96ccc0c8/memberOf?api-version=1.6
Получение списка групп, членом (постоянным) которых является пользователь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=1.6
Запрос и фильтр для групп с displayName >= "az" and <= "dz"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=1.6

Примечание. Пробел в строке запроса должен быть закодирован в формате URL перед отправкой запроса.Note: White space in the query string should be URL-encoded before sending a request.Например, следующая строка запроса 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.For example, the following query string, https://graph.windows.net/contoso.com/Users?$filter=displayName eq 'Jon Doe'&api-version=1.6, should be URL encoded as: https://graph.windows.net/contoso.com/Users?$filter=displayName%20eq%20'Jon%20Doe'&api-version=1.6.

© 2018 Microsoft