reportRoot: getCredentialUsageSummary
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Сообщите о текущем состоянии того, сколько пользователей в организации использовали возможности самостоятельного сброса пароля.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | Reports.Read.All | Недоступно. |
Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
Для приложений | Reports.Read.All | Недоступно. |
В делегированных сценариях вызывающий пользователь должен иметь по крайней мере одну из следующих Microsoft Entra ролей:
- Читатель отчетов
- Читатель сведений о безопасности
- Администратор безопасности
- Глобальный читатель
HTTP-запрос
GET /reports/getCredentialUsageSummary(period='{periodValue}')
Параметры функции
Чтобы запросить интервал времени для ответа, необходимо использовать следующий параметр функции.
Параметр | Тип | Описание |
---|---|---|
period | String | Обязательный. Указывает период времени в днях, для которого требуются данные об использовании. Пример: /reports/getCredentialUsageSummary(period='D30') . Поддерживаемые периоды: D1 , D7 и D30 . Точка не учитывает регистр. |
Необязательные параметры запросов
Эта функция поддерживает необязательный параметр запроса OData $filter. Вы можете применить $filter к одному или нескольким из следующих свойств ресурса credentialUsageSummary .
Свойства | Описание и пример |
---|---|
Функция | Указывает тип нужных данных об использовании (регистрация и сброс). Пример: /reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration' . Поддерживаемые операторы фильтра: eq . |
Заголовки запросов
Имя | Описание |
---|---|
Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Content-Type | application/json |
Текст запроса
Не указывайте текст запроса для этого метода.
Отклик
В случае успешного выполнения этот метод возвращает код отклика 200 OK
и новый объект коллекции credentialUsageSummary в теле отклика.
Примеры
В приведенном ниже примере показано, как вызывать этот API.
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости. Все свойства возвращаются из фактического вызова.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/reports/$metadata#Collection(microsoft.graph.getCredentialUsageSummary)",
"value":[
{
"id" : "id-value",
"feature":"registration",
"successfulActivityCount":12345,
"failureActivityCount": 123,
"authMethod": "email"
}
]
}
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по