reportRoot: getOffice365ActiveUserDetail

[アーティクル]
10/30/2023

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

Microsoft 365 アクティブユーザーに関する詳細を取得します。

注: 各レポートのビューとレポート名の詳細については、「Microsoft 365 レポート:　アクティブなユーザー」を参照してください。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類	最小特権アクセス許可	より高い特権のアクセス許可
委任 (職場または学校のアカウント)	Reports.Read.All	注意事項なし。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	Reports.Read.All	注意事項なし。

注: アプリがユーザーの代わりにサービス使用状況レポートを読み取ることができるように委任されたアクセス許可の場合、テナント管理者はユーザーに適切な Microsoft Entra ID 制限付き管理者ロールを割り当てる必要があります。詳細については、「Microsoft 365 利用状況レポートを読み込むための API 用の承認」を参照してください。

HTTP 要求

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

関数パラメーター

要求 URL に、次のうちの 1 つのパラメーターと有効な値を指定します。

パラメーター	種類	説明
period	文字列	レポートを集計する期間の長さを指定します。 {period_value} でサポートされている値は D7、D30、D90、D180 です。これらの値は、Dn の形式 (n はレポートを集計する日数) に従います。
date	日付	何らかのアクティビティを実行したユーザーを表示する日付を指定します。 {date_value} は YYYY-MM-DD の形式にします。このレポートは、過去 30 日間のみ利用可能であり、{date_value} はその範囲内の日付である必要があります。

注: URL に期間または日付を設定する必要があります。

このメソッドは、 $format、 $top、 $skipTokenOData クエリパラメーターをサポートし、応答をカスタマイズします。既定の出力の種類は text/csv です。ただし、出力の種類を指定する場合は、テキスト/csv または application/json に設定された OData $format クエリパラメーターを使用できます。

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と認可についての詳細をご覧ください。

応答

CSV

成功すると、レポートの事前認証されたダウンロード URL にリダイレクトする 302 Found 応答が返されます。その URL は、応答の Location ヘッダー内にあります。

事前認証されたダウンロード URL は、短期間 (数分) のみ有効で、Authorization ヘッダーを必要としません。

この CSV ファイルには、次の列ヘッダーがあります。

レポートの更新日
ユーザープリンシパル名
表示名
削除済み
削除日
Exchange ライセンスがある
OneDrive ライセンスがある
SharePoint ライセンスがある
Skype for Business ライセンスがある
Yammer ライセンスがある
Teams ライセンスがある
Exchange の最後のアクティビティ日付
OneDrive の最後のアクティビティ日付
SharePoint の最後のアクティビティ日付
Skype For Business の最後のアクティビティ日付
Yammer の最後のアクティビティ日付
Teams の最後のアクティビティ日付
Exchange のライセンス割り当て日
OneDrive のライセンス割り当て日
SharePoint のライセンス割り当て日
Skype For Business のライセンス割り当て日
Yammer のライセンス割り当て日
Teams のライセンス割り当て日
割り当て済み製品

21Vianet が運営する Microsoft Graph China では、次の列はサポートされていません。

Yammer ライセンスがある
Teams ライセンスがある
Yammer の最後のアクティビティ日付
Teams の最後のアクティビティ日付
Yammer のライセンス割り当て日
Teams のライセンス割り当て日

JSON

成功した場合、このメソッドは応答コード 200 OK と、応答本文に office365ActiveUserDetail オブジェクトを返します。

office365ActiveUserDetail オブジェクトの次のプロパティは、21Vianet が運営する Microsoft Graph China ではサポートされていません。

hasYammerLicense
hasTeamsLicense
yammerLastActivityDate
teamsLastActivityDate
yammerLicenseAssignDate
teamsLicenseAssignDate

この要求の既定のページサイズは 200 項目です。

例

CSV

CSV を出力する例を次に示します。

要求

次の例は要求を示しています。

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

応答

次の例は応答を示しています。

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

302 リダイレクトに従うと、ダウンロードされる CSV ファイルは次のスキーマを持つことになります。

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

JSON を返す例を次に示します。

要求

次の例は要求を示しています。

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

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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"
      ]
    }
  ]
}

次の方法で共有

reportRoot: getOffice365ActiveUserDetail

アクセス許可

HTTP 要求

関数パラメーター

要求ヘッダー

応答

CSV

JSON

例

CSV

要求

応答

JSON

要求

応答

フィードバック

その他のリソース