Enumeración de userCredentialUsageDetails

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Obtenga una lista de objetos userCredentialUsageDetails para un inquilino determinado. Los detalles incluyen la información del usuario, el estado del restablecimiento y el motivo del error.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) Reports.Read.All No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación Reports.Read.All No disponible.

Para escenarios delegados, el usuario que realiza la llamada debe tener al menos uno de los siguientes roles de Microsoft Entra:

  • Lector de informes
  • Lector de seguridad
  • Administrador de seguridad
  • Lector global

Solicitud HTTP

GET /reports/userCredentialUsageDetails

Parámetros de consulta opcionales

Esta función admite el parámetro de consulta opcional de OData $filter. Puede aplicar $filter en una o varias de las siguientes propiedades del recurso userCredentialUsageDetails .

Propiedades Descripción y ejemplo
Característica Filtre por tipo de datos de uso que desee (registro frente a restablecimiento). Por ejemplo: /reports/userCredentialUsageDetails?$filter=feature eq 'registration'. Operadores de filtro admitidos: eq
userDisplayName Filtre por nombre para mostrar de usuario. Por ejemplo: /reports/userCredentialUsageDetails?$filter=userDisplayName eq 'Contoso'. Operadores de filtro admitidos: eq y startswith(). Admite la distinción entre mayúsculas y minúsculas.
userPrincipalName Filtre por nombre principal de usuario. Por ejemplo: /reports/userCredentialUsageDetails?$filter=userPrincipalName eq 'Contoso'. Operadores de filtro admitidos: eq y startswith(). Admite la distinción entre mayúsculas y minúsculas.
isSuccess Filtre por estado de la actividad. Por ejemplo: /reports/userCredentialUsageDetails?$filter=isSuccess eq true. Operadores de filtro admitidos: eq y orderby.
authMethod Filtre por los métodos de autenticación que usan durante el registro. Por ejemplo: /reports/userCredentialUsageDetails?$filter=authMethod eq microsoft.graph.usageAuthMethod'email'. Operadores de filtro admitidos: eq.
failureReason Filtre por motivo de error (si se produjo un error en la actividad). Por ejemplo: /reports/userCredentialUsageDetails?$filter=failureReason eq 'Contoso'. Operadores de filtro admitidos: eq y startswith(). Admite la distinción entre mayúsculas y minúsculas.

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type application/json

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y una colección de objetos userCredentialUsageDetails en el cuerpo de la respuesta.

Ejemplos

En el siguiente ejemplo se muestra cómo llamar a esta API.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad. Todas las propiedades se devuelven desde una llamada real.

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