Share via

Список userCredentialUsageDetails

  • Статья

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

Важно!

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

Получите список объектов userCredentialUsageDetails для данного клиента. Сведения включают сведения о пользователе, состоянии сброса и причину сбоя.

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

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

Разрешения

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

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) Reports.Read.All Недоступно.
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Для приложений Reports.Read.All Недоступно.

В делегированных сценариях вызывающий пользователь должен иметь по крайней мере одну из следующих Microsoft Entra ролей:

  • Читатель отчетов
  • Читатель сведений о безопасности
  • Администратор безопасности
  • Глобальный читатель

HTTP-запрос

GET /reports/userCredentialUsageDetails

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

Эта функция поддерживает необязательный параметр запроса OData $filter. Вы можете применить $filter к одному или нескольким из следующих свойств ресурса userCredentialUsageDetails .

Свойства Описание и пример
Функция Фильтрация по типу нужных данных об использовании (регистрация и сброс). Пример: /reports/userCredentialUsageDetails?$filter=feature eq 'registration'. Поддерживаемые операторы фильтра: eq
userDisplayName Фильтрация по отображаемого имени пользователя. Пример: /reports/userCredentialUsageDetails?$filter=userDisplayName eq 'Contoso'. Поддерживаемые операторы фильтра: eq и startswith(). Поддерживает без учета регистра.
userPrincipalName. Фильтрация по имени субъекта-пользователя. Пример: /reports/userCredentialUsageDetails?$filter=userPrincipalName eq 'Contoso'. Поддерживаемые операторы фильтра: eq и startswith(). Поддерживает без учета регистра.
isSuccess Фильтрация по состоянию действия. Пример: /reports/userCredentialUsageDetails?$filter=isSuccess eq true. Поддерживаемые операторы фильтра: eq и orderby.
authMethod Фильтрация по методам проверки подлинности, которые используются во время регистрации. Пример: /reports/userCredentialUsageDetails?$filter=authMethod eq microsoft.graph.usageAuthMethod'email'. Поддерживаемые операторы фильтра: eq.
failureReason Фильтрация по причине сбоя (если действие завершилось сбоем). Пример: /reports/userCredentialUsageDetails?$filter=failureReason eq 'Contoso'. Поддерживаемые операторы фильтра: eq и startswith(). Поддерживает без учета регистра.

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

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

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

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

Отклик

В случае успешного 200 OK выполнения этот метод возвращает код отклика и коллекцию объектов userCredentialUsageDetails в теле отклика.

Примеры

В приведенном ниже примере показано, как вызывать этот API.

Запрос

Ниже показан пример запроса.

GET https://graph.microsoft.com/beta/reports/userCredentialUsageDetails

Отклик

Ниже показан пример отклика.

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

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

{
  "@odata.context":"https://graph.microsoft.com/beta/reports/$metadata#Collection(microsoft.graph.getUserCredentialUsageDetails)",
  "value":[
    {
      "id" : "id-value",
      "feature":"registration",
      "userPrincipalName":"userPrincipalName-value",
      "userDisplayName": "userDisplayName-value",
      "isSuccess" : true,
      "authMethod": "email",
      "failureReason": "User contacted an admin after trying the email verification option",
      "eventDateTime" : "2019-04-01T00:00:00Z"
    }
  ]
}