reportRoot: getOffice365ActiveUserDetail

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.

Obter detalhes sobre usuários ativos do Microsoft 365.

Observação: Para saber mais sobre os diferentes modos de exibição de relatório e nomes, confira Relatórios do Microsoft 365 - Usuários Ativos.

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.

Observação: Para que as permissões delegadas permitam que os aplicativos leiam relatórios de uso do serviço em nome de um usuário, o administrador do locatário deve ter atribuído ao usuário a função de administrador adequada Microsoft Entra ID limitada. Para saber mais, confira Autorização para APIs lerem os relatórios de uso do Microsoft 365.

Solicitação HTTP

GET /reports/getOffice365ActiveUserDetail(period='{period_value}')
GET /reports/getOffice365ActiveUserDetail(date={date_value})

Parâmetros de função

Na URL da solicitação, forneça um valor válido a um dos seguintes parâmetros.

Parâmetro	Tipo	Descrição
ponto	cadeia de caracteres	Especifica o período de tempo durante o qual o relatório é agregado. Os valores com suporte para {period_value} são: D7, D30, D90 e D180. Eles seguem o formato Dn, em que n representa o número de dias em que o relatório é agregado.
data	Data	Especifica a data para a qual você deseja visualizar os usuários que realizaram qualquer atividade. {date_value} deve ter um formato de AAAA-MM-DD. Como este relatório está disponível apenas para os últimos 30 dias, {date_value} deve ser uma data desse intervalo.

Observação: você precisa definir o período ou data na URL.

Esse método dá suporte aos $formatparâmetros de consulta , $tope $skipTokenOData para personalizar a resposta. O tipo de saída padrão é text/csv. No entanto, se você quiser especificar o tipo de saída, poderá usar o parâmetro de consulta OData $format definido como text/csv ou application/json.

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Resposta

CSV

Se for bem-sucedido, este método retorna uma resposta 302 Found que redireciona para uma URL de download pré-autenticada para o relatório. Essa URL pode ser encontrada no cabeçalho Location na resposta.

As URLs de download previamente autenticadas são válidas apenas por um curto período de tempo (alguns minutos) e não exigem um cabeçalho Authorization.

O arquivo CSV possui os seguintes cabeçalhos para colunas:

• Data de atualização do relatório
• Nome UPN
• Nome de exibição
• Excluído
• Data de exclusão
• Tem a licença do Exchange
• Tem a licença do OneDrive
• Tem a licença do SharePoint
• Tem a licença do Skype for Business
• Tem a licença do Yammer
• Tem a licença do Teams
• Data da última atividade do Exchange
• Data da última atividade do OneDrive
• Data da última atividade do SharePoint
• Data da última atividade do Skype for Business
• Data da última atividade do Yammer
• Data da última atividade do Teams
• Data de atribuição da licença do Exchange
• Data de atribuição da licença do OneDrive
• Data de atribuição da licença do SharePoint
• Data de atribuição da licença do Skype for Business
• Data de atribuição da licença do Yammer
• Data de atribuição da licença do Teams
• Produtos Atribuídos

As colunas a seguir não têm suporte no Microsoft Graph China operado pela 21Vianet:

• Tem a licença do Yammer
• Tem a licença do Teams
• Data da última atividade do Yammer
• Data da última atividade do Teams
• Data de atribuição da licença do Yammer
• Data de atribuição da licença do Teams

JSON

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e um objeto office365ActiveUserDetail no corpo da resposta.

As seguintes propriedades no objeto office365ActiveUserDetail não têm suporte no Microsoft Graph China operado pela 21Vianet:

• hasYammerLicense
• hasTeamsLicense
• yammerLastActivityDate
• teamsLastActivityDate
• yammerLicenseAssignDate
• teamsLicenseAssignDate

O tamanho da página padrão para essa solicitação é de 200 itens.

Exemplo

CSV

A seguir está um exemplo que gera CSV.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/reports/getOffice365ActiveUserDetail(period='D7')?$format=text/csv

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe

Siga o redirecionamento 302 e o arquivo CSV baixado terá o seguinte esquema.

HTTP/1.1 200 OK
Content-Type: application/octet-stream

Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Has Exchange License,Has OneDrive License,Has SharePoint License,Has Skype For Business License,Has Yammer License,Has Teams License,Exchange Last Activity Date,OneDrive Last Activity Date,SharePoint Last Activity Date,Skype For Business Last Activity Date,Yammer Last Activity Date,Teams Last Activity Date,Exchange License Assign Date,OneDrive License Assign Date,SharePoint License Assign Date,Skype For Business License Assign Date,Yammer License Assign Date,Teams License Assign Date,Assigned Products

JSON

A seguir está um exemplo que retorna JSON.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/reports/getOffice365ActiveUserDetail(period='D7')?$format=application/json

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 853

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.office365ActiveUserDetail)", 
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "userPrincipalName": "userprincipalname-value", 
      "displayName": "displayname-value", 
      "isDeleted": false, 
      "deletedDate": null, 
      "hasExchangeLicense": true, 
      "hasOneDriveLicense": false, 
      "hasSharePointLicense": false, 
      "hasSkypeForBusinessLicense": false, 
      "hasYammerLicense": false, 
      "hasTeamsLicense": false, 
      "exchangeLastActivityDate": "2017-08-30", 
      "oneDriveLastActivityDate": null, 
      "sharePointLastActivityDate": null, 
      "skypeForBusinessLastActivityDate": null, 
      "yammerLastActivityDate": null, 
      "teamsLastActivityDate": null, 
      "exchangeLicenseAssignDate": "2016-05-03", 
      "oneDriveLicenseAssignDate": null, 
      "sharePointLicenseAssignDate": null, 
      "skypeForBusinessLicenseAssignDate": null, 
      "yammerLicenseAssignDate": null, 
      "teamsLicenseAssignDate": null, 
      "assignedProducts": [
        "Microsoft 365 ENTERPRISE E5"
      ]
    }
  ]
}