Listar 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, status da redefinição e o motivo da falha.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas 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 privilegiadas mais altas |
---|---|---|
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. |
Para cenários delegados, o usuário de chamada deve ter pelo menos uma das seguintes funções de Microsoft Entra:
- 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
Essa 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 | Filtrar por tipo de dados de uso desejados (registro versus redefinição). Por exemplo: /reports/userCredentialUsageDetails?$filter=feature eq 'registration' . Operadores de filtro com suporte: eq |
userDisplayName | Filtrar pelo nome de exibição do usuário. Por exemplo: /reports/userCredentialUsageDetails?$filter=userDisplayName eq 'Contoso' . Operadores de filtro com suporte: eq e startswith() . Dá suporte a casos insensíveis. |
userPrincipalName | Filtrar pelo nome da entidade de usuário. Por exemplo: /reports/userCredentialUsageDetails?$filter=userPrincipalName eq 'Contoso' . Operadores de filtro com suporte: eq e startswith() . Dá suporte a casos insensíveis. |
isSuccess | Filtrar por status da atividade. Por exemplo: /reports/userCredentialUsageDetails?$filter=isSuccess eq true . Operadores de filtro com suporte: eq e orderby . |
authMethod | Filtrar pelos métodos de autenticação usando durante o registro. Por exemplo: /reports/userCredentialUsageDetails?$filter=authMethod eq microsoft.graph.usageAuthMethod'email' . Operadores de filtro com suporte: eq . |
failureReason | Filtrar por motivo de falha (se a atividade tiver falhado). Por exemplo: /reports/userCredentialUsageDetails?$filter=failureReason eq 'Contoso' . Operadores de filtro com suporte: eq e startswith() . Dá suporte a casos insensíveis. |
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"
}
]
}