Répertorier userCredentialUsageDetails

  • Article

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 la liste des objets userCredentialUsageDetails pour un locataire donné. Les détails incluent les informations utilisateur, status de la réinitialisation et la raison de l’échec.

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

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

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

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
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.

Pour les scénarios délégués, l’utilisateur appelant doit avoir au moins l’un des rôles Microsoft Entra suivants :

  • 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 OData facultatif $filter. Vous pouvez appliquer $filter sur une ou plusieurs des propriétés suivantes de la ressource userCredentialUsageDetails .

Propriétés Description et exemple
Fonction Filtrez par type de données d’utilisation souhaitées (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 d’utilisateur. Par exemple : /reports/userCredentialUsageDetails?$filter=userDisplayName eq 'Contoso'. Opérateurs de filtre pris en charge : eq et startswith(). Prend en charge l’insensible à la casse.
userPrincipalName Filtrez 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’insensible à la casse.
isSuccess Filtrez 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 par les méthodes d’authentification à l’aide de lors de l’inscription. Par exemple : /reports/userCredentialUsageDetails?$filter=authMethod eq microsoft.graph.usageAuthMethod'email'. Opérateurs de filtre pris en charge : eq.
failureReason Filtrez 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’insensible à la casse.

En-têtes de demande

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

Corps de la demande

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

Réponse

Si elle réussit, 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"
    }
  ]
}