Вывод списка удаленных элементов (объектов каталога)

  • Статья

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Получите список недавно удаленных объектов каталога. В настоящее время функциональность удаленных элементов поддерживается только для приложений, servicePrincipal, externalUserProfile, группы, административной единицы, pendingExternalUserProfile и пользовательских ресурсов.

Примечание: Удаленные группы безопасности удаляются безвозвратно и не могут быть извлечены с помощью этого API.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ✅ ✅ ✅

Разрешения

В следующей таблице показаны наименее привилегированные разрешения или разрешения, необходимые для вызова этого API для каждого поддерживаемого типа ресурсов. Следуйте рекомендациям , чтобы запросить разрешения с наименьшими привилегиями. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Поддерживаемый ресурс Делегированное (рабочая или учебная учетная запись) Делегированное (личная учетная запись Майкрософт) Приложение
administrativeUnit AdministrativeUnit.Read.All Не поддерживается. AdministrativeUnit.Read.All
application Application.Read.All Не поддерживается. Application.Read.All
externalUserProfile ExternalUserProfile.Read.All Не поддерживается ExternalUserProfile.Read.All
group Group.Read.All Не поддерживается. Group.Read.All
pendingExternalUserProfile PendingExternalUserProfile.Read.All Не поддерживается PendingExternalUserProfile.Read.All
servicePrincipal Application.Read.All Не поддерживается. Application.Read.All
user User.Read.All Не поддерживается. User.Read.All

Когда приложение запрашивает связь, которая возвращает коллекцию типов directoryObject , если у него нет разрешения на чтение определенного производного типа (например, устройство), возвращаются члены этого типа, но с ограниченной информацией. При таком поведении приложения могут запрашивать необходимые разрешения с наименьшими привилегиями, а не полагаться на набор каталогов.*Разрешения. Сведения см. в разделе Ограниченные сведения, возвращаемые для недоступных объектов member.

HTTP-запрос

GET /directory/deleteditems/microsoft.graph.application
GET /directory/deleteditems/microsoft.graph.servicePrincipal
GET /directory/deleteditems/microsoft.graph.group
GET /directory/deletedItems/microsoft.graph.user
GET /directory/deletedItems/microsoft.graph.administrativeUnit
GET /directory/deletedItems/microsoft.graph.externalUserProfile
GET /directory/deletedItems/microsoft.graph.pendingExternalUserProfile

Тип приведения OData является обязательной частью URI, и вызов GET /directory/deleteditems без типа не поддерживается.

Необязательные параметры запросов

Этот метод поддерживает параметры запроса, поддерживаемые ресурсом, заданным приведением OData. То есть параметры $countзапроса , $expand, $filter, $search$orderby, , $selectи $top . Этот API возвращает 100 объектов по умолчанию и поддерживает возврат до 999 объектов на страницу с помощью $top.

Некоторые запросы поддерживаются только при использовании заголовка ConsistencyLevel с присвоенным значением eventual и $count. Например:

https://graph.microsoft.com/beta/directory/deletedItems/microsoft.graph.group?&$count=true&$orderby=deletedDateTime desc&$select=id,displayName,deletedDateTime
ConsistencyLevel: eventual

В этом примере требуется заголовок ConsistencyLevel , так как $orderby в запросе используются параметры запроса и $count .

примеры параметров запроса OData $orderby

Параметр $orderby запроса OData поддерживается в свойствах deletedDateTime, displayName и userPrincipalName удаленных типов объектов. В свойстве deletedDateTime запрос требует добавления дополнительных параметров запроса (для заголовка ConsistencyLevel задано значение eventual и $count=true строка запроса).

Приведение OData Свойства, поддерживающие $orderby Пример
microsoft.graph.user deletedDateTime, displayName, userPrincipalName /directory/deletedItems/microsoft.graph.user?$orderby=userPrincipalName
microsoft.graph.group deletedDateTime, displayName /directory/deletedItems/microsoft.graph.group?$orderby=deletedDateTime asc&$count=true
microsoft.graph.application deletedDateTime, displayName /directory/deletedItems/microsoft.graph.application?$orderby=displayName
microsoft.graph.device deletedDateTime, displayName /directory/deletedItems/microsoft.graph.device?$orderby=deletedDateTime&$count=true

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Accept application/json

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успеха этот метод возвращает код отклика 200 OK и коллекцию объектов directoryObject в тексте отклика.

Примеры

Пример 1. Получение удаленных групп

Запрос

GET https://graph.microsoft.com/beta/directory/deleteditems/microsoft.graph.group

Отклик

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#groups",
  "value": [
    {
      "id":"46cc6179-19d0-473e-97ad-6ff84347bbbb",
      "displayName":"SampleGroup",
      "groupTypes":["Unified"],
      "mail":"example@contoso.com",
      "mailEnabled":true,
      "mailNickname":"Example",
      "securityEnabled":false,
      "visibility":"Public"
    }
  ]
}

Пример 2. Получение количества удаленных пользовательских объектов и упорядочивание результатов по свойству deletedDateTime

Запрос

GET https://graph.microsoft.com/beta/directory/deletedItems/microsoft.graph.group?$count=true&$orderby=deletedDateTime asc&$select=id,displayName,deletedDateTime
ConsistencyLevel: eventual

Отклик

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#groups(id,displayName,deletedDateTime)",
    "@odata.count": 2,
    "value": [
        {
            "id": "c31799b8-0683-4d70-9e91-e032c89d3035",
            "displayName": "Role assignable group",
            "deletedDateTime": "2021-10-26T16:56:36Z"
        },
        {
            "id": "74e45ce0-a52a-4766-976c-7201b0f99370",
            "displayName": "Role assignable group",
            "deletedDateTime": "2021-10-26T16:58:37Z"
        }
    ]
}