POST api/v1/group/Permission/export

特定のグループの権限関連情報をエクスポートすることで .zip ファイルを取得します。

http://hostname:port/api/v1/group/Permission/export

 

{

Emails: [Group ID 1, Group ID 2],

siteUrls: [

        https://yourcompany.sharepoint.com/sites/site01,

        https://yourcompany.sharepoint.com/sites/site02

],

dataSources: [Microsoft Teams, SharePoint Online],

ExportOptionType: 2,

Language: en-US

}

要求情報

要素

説明

種類

必須

Emails

レポートをエクスポートしようとしているグループの IDを設定します。

String Array

はい

SiteUrl

グループのレポートをエクスポートするサイト コレクションを設定します。最大 100 件のサイト コレクションを設定できます。

String Array

いいえ

dataSources

グループのレポートをエクスポートするワークスペースを設定します。複数の値が許可されます。

String Array

 

有効な値は次のとおりです。

Microsoft Teams

SharePoint Online

OneDrive

Microsoft 365 グループ

はい

ExportOptionType

エクスポートしようとしているレポートのエクスポート オプションを設定します。

Int

有効な値は次のとおりです。

1 (サマリー レポートとサイト コレクション レベルのアクセス レポートの両方をエクスポートします)

2 (サマリー レポートと構成済みデータ範囲内のすべてのオブジェクトに対するアクセス レポートの両方をエクスポートします)

3 (サマリー レポートのみをエクスポートします)

はい

Language

取得しようとしている情報の言語を設定します。

String

有効な値は次のとおりです。

en-US (英語) (既定)

ja-JP (日本語)

fr-FR (フランス語)

いいえ

 

*注意: すべてのグループのレポートをエクスポートするには、emails を空にして、exportOptionType 3 が設定されていることを確認してください。

応答情報

要素

説明

種類

getFileUrl

エクスポートされた権限レポート ファイルを取得する API URL です。

String

id

エクスポートされた権限レポートファイルの固有 ID です。

Int

サンプル レポート

この API を使用して .zip ファイルはエクスポートされます。定義したエクスポート オプションに基づいて、エクスポートされたレポートが異なります。

    サマリー レポートのみをエクスポートする場合、エクスポート範囲内のグループのサマリー レポートが .zip ファイルに含まれます。

    サマリー レポートとサイト コレクション レベルのアクセス レポートの両方をエクスポートする場合、エクスポート範囲内のすべてのグループのサマリー レポートと、構成済みデータ範囲内のサイト コレクションへのこれらのグループのアクセス レポートが .zip ファイルに含まれます。

    サマリー レポートとアクセス レポートの両方をエクスポートする場合、エクスポート範囲内のサマリー レポートと各グループの構成済みデータ範囲内のすべてのオブジェクトに対するアクセス レポートがそれぞれ .zip ファイルに含まれます。

サンプル サマリー レポート

The sample summary report.

サンプル サイト コレクション レベルのアクセス レポート

Access Report of Groups with External Users.

サンプル アクセス レポート

User/Group Access Report.