reportRoot: getCredentialUsageSummaryreportRoot: getCredentialUsageSummary

Espacio de nombres: microsoft.graphNamespace: microsoft.graph

Importante

Las API de la /beta versión de Microsoft Graph están sujetas a cambios.APIs under the /beta version in Microsoft Graph are subject to change. No se admite el uso de estas API en aplicaciones de producción.Use of these APIs in production applications is not supported. Para determinar si una API está disponible en v 1.0, use el selector de versiones .To determine whether an API is available in v1.0, use the Version selector.

Informa sobre el estado actual de la cantidad de usuarios de la organización que usaron la funcionalidad de restablecimiento de contraseña de autoservicio.Report the current state of how many users in your organization used the self-service password reset capabilities.

PermisosPermissions

Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permisoPermission type Permisos (de menos a más privilegiados)Permissions (from least to most privileged)
Delegado (cuenta profesional o educativa)Delegated (work or school account) Reports.Read.AllReports.Read.All
Delegado (cuenta personal de Microsoft)Delegated (personal Microsoft account) No admitida.Not supported.
AplicaciónApplication Reports.Read.AllReports.Read.All

Solicitud HTTPHTTP request

GET /reports/getCredentialUsageSummary

Parámetros de funciónFunction parameters

Puede usar el siguiente parámetro de función para ajustar la respuesta.You can use the following function parameter to adjust the response.

ParámetroParameter TipoType DescripciónDescription
periodperiod StringString Especifica el período de tiempo para el que se necesitan los datos de uso.Specifies the time period for which you need the usage data. Por ejemplo: /reports/getCredentialUsageSummary(period='D30').For example: /reports/getCredentialUsageSummary(period='D30'). Períodos admitidos: D1 , D7 y D30 .Supported periods: D1, D7, and D30. El período no distingue mayúsculas de minúsculas.Period is case insensitive.

Parámetros de consulta opcionalesOptional query parameters

Esta función admite el parámetro de consulta opcional $Filterde oData.This function supports the optional OData query parameter $filter. Puede aplicar $Filter en una o varias de las siguientes propiedades del recurso credentialUsageSummary .You can apply $filter on one or more of the following properties of the credentialUsageSummary resource.

PropiedadesProperties Descripción y ejemploDescription and example
Featurefeature Especifica el tipo de datos de uso que desea (registro y restablecimiento).Specifies the type of usage data you want (registration vs. reset). Por ejemplo: /reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'.For example: /reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'. Operadores de filtro admitidos: eq .Supported filter operators: eq.

Encabezados de solicitudRequest headers

NombreName DescripciónDescription
AuthorizationAuthorization Bearer {token}Bearer {token}
Content-TypeContent-Type application/jsonapplication/json

Cuerpo de la solicitudRequest body

No proporcione un cuerpo de solicitud para este método.Do not supply a request body for this method.

RespuestaResponse

Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y un nuevo objeto de la colección credentialUsageSummary en el cuerpo de la respuesta.If successful, this method returns a 200 OK response code and a new credentialUsageSummary collection object in the response body.

EjemplosExamples

En el siguiente ejemplo se muestra cómo llamar a esta API.The following example shows how to call this API.

SolicitudRequest

Aquí tiene un ejemplo de la solicitud.The following is an example of the request.

GET https://graph.microsoft.com/beta/reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'

RespuestaResponse

Aquí tiene un ejemplo de la respuesta.The following is an example of the response.

Nota: Se puede reducir el objeto de respuesta que se muestra aquí para mejorar la legibilidad.Note: The response object shown here might be shortened for readability. Todas las propiedades se devuelven de una llamada real.All the properties are returned from an actual call.

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