List userCredentialUsageDetails

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Obtenez une liste des objets userCredentialUsageDetails pour un client donné. Les détails incluent les informations de l’utilisateur, le status de la réinitialisation et la raison de l’échec.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Reports.Read.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Reports.Read.All Non disponible.

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit être propriétaire ou membre du groupe ou disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé qui accorde les autorisations requises pour cette opération. Cette opération prend en charge les rôles intégrés suivants, qui n’offrent que le moindre privilège nécessaire :

  • Lecteur de rapports
  • Lecteur de sécurité
  • Administrateur de sécurité
  • Lecteur général

Requête HTTP

GET /reports/userCredentialUsageDetails

Paramètres facultatifs de la requête

Cette fonction prend en charge le paramètre de requête facultatif OData $filter. Vous pouvez appliquer $filter sur une ou plusieurs des propriétés suivantes de la ressource userCredentialUsageDetails .

Propriétés Description et exemple
Caractéristique Filtrez par type de données d’utilisation que vous souhaitez (inscription ou réinitialisation). Par exemple : /reports/userCredentialUsageDetails?$filter=feature eq 'registration'. Opérateurs de filtre pris en charge : eq
userDisplayName Filtrer par nom d’affichage de l’utilisateur. Par exemple : /reports/userCredentialUsageDetails?$filter=userDisplayName eq 'Contoso'. Opérateurs de filtre pris en charge : eq et startswith(). Prend en charge l’insensibilité à la casse.
userPrincipalName Filtrer par nom d’utilisateur principal. Par exemple : /reports/userCredentialUsageDetails?$filter=userPrincipalName eq 'Contoso'. Opérateurs de filtre pris en charge : eq et startswith(). Prend en charge l’insensibilité à la casse.
isSuccess Filtrer par status de l’activité. Par exemple : /reports/userCredentialUsageDetails?$filter=isSuccess eq true. Opérateurs de filtre pris en charge : eq et orderby.
authMethod Filtrez en fonction des méthodes d’authentification à utiliser lors de l’inscription. Par exemple : /reports/userCredentialUsageDetails?$filter=authMethod eq microsoft.graph.usageAuthMethod'email'. Opérateurs de filtre pris en charge : eq.
failureReason Filtrer par raison de l’échec (si l’activité a échoué). Par exemple : /reports/userCredentialUsageDetails?$filter=failureReason eq 'Contoso'. Opérateurs de filtre pris en charge : eq et startswith(). Prend en charge l’insensibilité à la casse.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

En cas de réussite, cette méthode renvoie un 200 OK code de réponse et une collection d’objets userCredentialUsageDetails dans le corps de la réponse.

Exemples

L’exemple ci-après montre comment appeler cette API.

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité. Toutes les propriétés sont retournées à partir d’un appel réel.

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"
    }
  ]
}