特定のサイト コレクションの権限関連情報を取得します。
*注意: api/v1/site/permission/export API は、エクスポートしようとしているサイト コレクションが 2,000 件を超える場合に推奨されます。
http://hostname:port/api/v1/Site/permission
{ “SiteUrls”: [“https://yourcompany.sharepoint.com/sites/site01”], “Token”: null, “Top”: 100, “Language”: “en-US”
} |
{ “results”: [ { “module”: “Microsoft Teams”, “name”: “site01”, “url”: “https://yourcompany.sharepoint.com/sites/site01”, “objectType”: “Site Collection”, “principalName”: “site01 Owners”, “email”: “”, “principalType”: “SharePoint Group”, “permission”: “Full Control”, “numberOfMembers”: 0, “isExternalUser”: false, “inheritType”: false, “linkGivingAccessTo”: null } ], “status”: 200, “message”: “”, “content”: null, “nextToken”: “{Next Token}” } |
要素 |
説明 |
種類 |
必須 |
SiteUrl |
権限関連情報を取得するサイト コレクションの URL を設定します。URL は最大 100 件です。 |
リスト |
はい |
Language |
取得しようとしている情報の言語を設定します。
|
String 有効な値は次のとおりです。 en-US (英語) (既定) ja-JP (日本語) fr-FR (フランス語) |
いいえ |
Token |
100 件以上の結果が出たリクエストの残りの結果を取得するかどうかを設定します。 |
String |
いいえ |
Top |
1 ページ分の検索結果の数を設定します。最大で 1 ページに 100 件の検索結果が表示されます。 |
Int |
いいえ |
要素 |
説明 |
種類 | |
results |
module |
データ ソース |
String |
name |
権限の名前 |
String | |
url |
オブジェクトの URL |
String | |
objectType |
オブジェクト タイプです。 |
String | |
principalName |
ユーザーまたはグループの名前 |
String | |
principalType |
ユーザーまたはグループのタイプ |
String | |
permission |
権限 |
String | |
numberOfMembers |
グループ内のメンバー数 |
Int | |
isExternalUser |
外部ユーザーが存在するかどうかの状態 |
Bool | |
inheritType |
オブジェクトが親からの継承を解除しているかどうかの状態 |
Bool | |
linkGivingAccessT |
リンクで許可されているメンバー |
String | |
status |
HTTP の応答状態コード |
Int | |
message |
エラー メッセージ |
String | |
nextToken |
このリクエストの残りの結果を得るために使用されるトークンです。 |
String |