reportRoot: getCredentialUsageSummary
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Melden Sie den aktuellen Status, wie viele Benutzer in Ihrem organization die Self-Service-Kennwortzurücksetzungsfunktionen verwendet haben.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
Weltweiter Service | US Government L4 | US Government L5 (DOD) | China, betrieben von 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Berechtigungen
Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
Berechtigungstyp | Berechtigungen mit den geringsten Berechtigungen | Berechtigungen mit höheren Berechtigungen |
---|---|---|
Delegiert (Geschäfts-, Schul- oder Unikonto) | Reports.Read.All | Nicht verfügbar. |
Delegiert (persönliches Microsoft-Konto) | Nicht unterstützt | Nicht unterstützt |
Anwendung | Reports.Read.All | Nicht verfügbar. |
Wichtig
In delegierten Szenarien mit Geschäfts-, Schul- oder Unikonten muss der angemeldete Benutzer Besitzer oder Mitglied der Gruppe sein oder einer unterstützten Microsoft Entra Rolle oder einer benutzerdefinierten Rolle mit einer unterstützten Rollenberechtigung zugewiesen sein. Die folgenden Rollen mit den geringsten Berechtigungen werden für diesen Vorgang unterstützt.
- Berichteleser
- Sicherheitsleseberechtigter
- Sicherheitsadministrator
- Globaler Leser
HTTP-Anforderung
GET /reports/getCredentialUsageSummary(period='{periodValue}')
Funktionsparameter
Sie müssen den folgenden Funktionsparameter verwenden, um einen Zeitrahmen für die Antwort anzufordern.
Parameter | Typ | Beschreibung |
---|---|---|
Zeitraum | String | Erforderlich. Gibt den Zeitraum in Tagen an, für den Sie die Nutzungsdaten benötigen. Beispiel: /reports/getCredentialUsageSummary(period='D30') . Unterstützte Zeiträume: D1 , D7 und D30 . Bei Punkt wird die Groß-/Kleinschreibung nicht beachtet. |
Optionale Abfrageparameter
Diese Funktion unterstützt den optionalen OData-Abfrageparameter $filter. Sie können $filter auf eine oder mehrere der folgenden Eigenschaften der Ressource credentialUsageSummary anwenden.
Eigenschaften | Beschreibung und Beispiel |
---|---|
Merkmal | Gibt den Typ der gewünschten Nutzungsdaten an (Registrierung im Vergleich zum Zurücksetzen). Beispiel: /reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration' . Unterstützte Filteroperatoren: eq . |
Anforderungsheader
Name | Beschreibung |
---|---|
Authorization | Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung. |
Content-Type | application/json |
Anforderungstext
Geben Sie keinen Anforderungstext für diese Methode an.
Antwort
Bei erfolgreicher Ausführung gibt die Methode einen 200 OK
Antwortcode und ein neues credentialUsageSummary-Auflistungsobjekt im Antworttext zurück.
Beispiele
Das folgende Beispiel illustriert, wie Sie diese API aufrufen können.
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
GET https://graph.microsoft.com/beta/reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'
Antwort
Das folgende Beispiel zeigt die Antwort.
Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden. Alle Eigenschaften werden von einem tatsächlichen Aufruf zurückgegeben.
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"
}
]
}