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 de versão.

Obter 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.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão	Permissões (da com menos para a com mais privilégios)
Delegada (conta corporativa ou de estudante)	Reports.Read.All
Delegada (conta pessoal da Microsoft)	Sem suporte.
Aplicativo	Reports.Read.All

Solicitação HTTP

GET /reports/userCredentialUsageDetails

Parâmetros de consulta opcionais

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

Propriedades	Descrição e exemplo
feature	Filtrar 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 pelo nome de exibição do usuário. Por exemplo: /reports/userCredentialUsageDetails?$filter=userDisplayName eq 'Contoso'. Operadores de filtro com suporte: eq e startswith() . Oferece suporte a maiúsculas e minúsculas.
userPrincipalName	Filtrar pelo nome principal do usuário. Por exemplo: /reports/userCredentialUsageDetails?$filter=userPrincipalName eq 'Contoso'. Operadores de filtro com suporte: eq e startswith() . Oferece suporte a maiúsculas e minúsculas.
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 que usam 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() . Oferece suporte a maiúsculas e minúsculas.

Cabeçalhos de solicitação

Nome	Descrição
Autorização	Portador {token}
Content-Type	application/json

Corpo da solicitação

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

Resposta

Se tiver êxito, este método retornará um código de resposta e uma coleção de 200 OK objetos userCredentialUsageDetails no corpo da resposta.

Exemplos

O exemplo a seguir mostra como chamar essa API.

Solicitação

Este é um exemplo de solicitação.

HTTP

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

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var userCredentialUsageDetails = await graphClient.Reports.UserCredentialUsageDetails
    .Request()
    .GetAsync();

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

let userCredentialUsageDetails = await client.api('/reports/userCredentialUsageDetails')
    .version('beta')
    .get();

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/reports/userCredentialUsageDetails"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        NSError *jsonError = nil;
        MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
        MSGraphUserCredentialUsageDetails *userCredentialUsageDetails = [[MSGraphUserCredentialUsageDetails alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];

}];

[meDataTask execute];

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

UserCredentialUsageDetailsCollectionPage userCredentialUsageDetails = graphClient.reports().userCredentialUsageDetails()
    .buildRequest()
    .get();

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

result, err := graphClient.Reports().UserCredentialUsageDetails().Get()

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

PowerShell

Import-Module Microsoft.Graph.Reports

Get-MgReportUserCredentialUsageDetail

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não dão suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider , consulte a documentação do SDK.

Resposta

Este é um exemplo de 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"
    }
  ]
}