List userCredentialUsageDetails

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Obtenha uma lista de objetos userCredentialUsageDetails para um determinado locatário. Os detalhes incluem informações do usuário, o status da redefinição e o motivo da falha.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ❌ ❌ ❌

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegada (conta corporativa ou de estudante) Reports.Read.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Reports.Read.All Indisponível.

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve ser proprietário ou membro do grupo ou ser atribuído a uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. Esta operação dá suporte às seguintes funções internas, que fornecem apenas o menor privilégio necessário:

  • Leitor de Relatórios
  • Leitor de segurança
  • Administrador de Segurança
  • Leitor Global

Solicitação HTTP

GET /reports/userCredentialUsageDetails

Parâmetros de consulta opcionais

Esta função dá suporte ao parâmetro de consulta OData opcional $filter. Você pode aplicar $filter em uma ou mais das seguintes propriedades do recurso userCredentialUsageDetails .

Propriedades Descrição e exemplo
Recurso Filtre por tipo de dados de uso que você deseja (registro versus redefinição). Por exemplo: /reports/userCredentialUsageDetails?$filter=feature eq 'registration'. Operadores de filtro com suporte: eq
userDisplayName Filtrar por nome de exibição do usuário. Por exemplo: /reports/userCredentialUsageDetails?$filter=userDisplayName eq 'Contoso'. Operadores de filtro compatíveis: eq e startswith(). Dá suporte a não diferenciar maiúsculas de minúsculas.
userPrincipalName Filtrar por nome UPN. Por exemplo: /reports/userCredentialUsageDetails?$filter=userPrincipalName eq 'Contoso'. Operadores de filtro compatíveis: eq e startswith(). Dá suporte a não diferenciar maiúsculas de minúsculas.
isSuccess Filtre pelo status da atividade. Por exemplo: /reports/userCredentialUsageDetails?$filter=isSuccess eq true. Operadores de filtro compatíveis: eq e orderby.
authMethod Filtre pelos métodos de autenticação usados durante o registro. Por exemplo: /reports/userCredentialUsageDetails?$filter=authMethod eq microsoft.graph.usageAuthMethod'email'. Operadores de filtro compatíveis: eq.
failureReason Filtre por motivo da falha (se a atividade falhou). Por exemplo: /reports/userCredentialUsageDetails?$filter=failureReason eq 'Contoso'. Operadores de filtro compatíveis: eq e startswith(). Dá suporte a não diferenciar maiúsculas de minúsculas.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e uma coleção de objetos userCredentialUsageDetails no corpo da resposta.

Exemplos

O exemplo a seguir mostra como chamar essa API.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade. Todas as propriedades são retornadas de uma chamada 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"
    }
  ]
}
  • Last updated on