reportRoot: getCredentialUsageSummaryreportRoot: getCredentialUsageSummary

Namespace: microsoft.graphNamespace: microsoft.graph

Importante

As APIs na /beta versão do Microsoft Graph estão sujeitas a alterações.APIs under the /beta version in Microsoft Graph are subject to change. Não há suporte para o uso dessas APIs em aplicativos de produção.Use of these APIs in production applications is not supported.

Informe o estado atual de quantos usuários da sua organização usaram as funcionalidades de redefinição de senha de autoatendimento.Report the current state of how many users in your organization used the self-service password reset capabilities.

PermissõesPermissions

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permissãoPermission type Permissões (da com menos para a com mais privilégios)Permissions (from least to most privileged)
Delegada (conta corporativa ou de estudante)Delegated (work or school account) Reports.Read.AllReports.Read.All
Delegada (conta pessoal da Microsoft)Delegated (personal Microsoft account) Sem suporte.Not supported.
AplicativoApplication Reports.Read.AllReports.Read.All

Solicitação HTTPHTTP request

GET /reports/getCredentialUsageSummary

Parâmetros de funçãoFunction parameters

Você pode usar o seguinte parâmetro de função para ajustar a resposta.You can use the following function parameter to adjust the response.

ParâmetroParameter TipoType DescriçãoDescription
pontoperiod Cadeia de caracteresString Especifica o período de tempo para o qual você precisa dos dados de uso.Specifies the time period for which you need the usage data. Por exemplo: /reports/getCredentialUsageSummary(period='D30').For example: /reports/getCredentialUsageSummary(period='D30'). Períodos suportados: D1 , D7 , e D30 .Supported periods: D1, D7, and D30. O período não diferencia maiúsculas de minúsculas.Period is case insensitive.

Parâmetros de consulta opcionaisOptional query parameters

Essa função suporta o parâmetro de consulta OData opcional $Filter.This function supports the optional OData query parameter $filter. Você pode aplicar $Filter em uma ou mais das seguintes propriedades do recurso credentialUsageSummary .You can apply $filter on one or more of the following properties of the credentialUsageSummary resource.

PropriedadesProperties Descrição e exemploDescription and example
apresentamfeature Especifica o tipo de dados de uso que você deseja (registro versus redefinição).Specifies the type of usage data you want (registration vs. reset). Por exemplo: /reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'.For example: /reports/getCredentialUsageSummary(period='D30')?$filter=feature eq 'registration'. Operadores de filtro suportados: eq .Supported filter operators: eq.

Cabeçalhos de solicitaçãoRequest headers

NomeName DescriçãoDescription
AutorizaçãoAuthorization Portador {token}Bearer {token}
Content-TypeContent-Type application/jsonapplication/json

Corpo da solicitaçãoRequest body

Não forneça um corpo de solicitação para esse método.Do not supply a request body for this method.

RespostaResponse

Se tiver êxito, este método retornará um 200 OK código de resposta e um novo objeto da coleção credentialUsageSummary no corpo da resposta.If successful, this method returns a 200 OK response code and a new credentialUsageSummary collection object in the response body.

ExemplosExamples

O exemplo a seguir mostra como chamar essa API.The following example shows how to call this API.

SolicitaçãoRequest

Este é um exemplo de solicitação.The following is an example of the request.

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

RespostaResponse

Este é um exemplo de resposta.The following is an example of the response.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.Note: The response object shown here might be shortened for readability. Todas as propriedades são retornadas de uma chamada 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"
    }
  ]
}