POST api/v1/Group/summary

特定のグループのサマリーを取得します。

要求の例

http://hostname:port/api/v1/Group/summary

 

{

“StartPage”: 1,

“PageSize”: 100,

“Language”: “en-US”

}

応答の例

{

“results”: [

        {

            “displayName”: “Demo Security Group”,

            “groupId”: “{Group ID}”,

            “email”: Demo@domain.com,

            “groupType”: “Microsoft 365 Group”,

            “membershipType”: “Assigned”,

            “createdOn”: “2022-03-07T08:19:41”,

            “externalMemberCount”: 17

        }

],

“status”: 200,

“message”: “”,

“content”: null,

“nextToken”: null

}

要求情報

要素

説明

種類

必須

Language

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

String

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

en-US (英語) (既定)

ja-JP (日本語)

fr-FR (フランス語)

いいえ

StartPage

グループ サマリーを取得する開始ページを設定します。

Int

既定の値は 1 です。

はい

PageSize

結果の各ページに表示するグループの数を設定します。その数は 100 以内で設定する必要があります。

Int

いいえ

応答情報

要素

説明

種類

results

displayName

グループ名

String

groupId

グループ ID

String

email

グループのメール アドレス

String

groupType

グループのタイプ

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

Microsoft 365 グループ

セキュリティ グループ

配布グループ

メールが有効なセキュリティ グループ

String

membershipType

グループのメンバーシップ タイプ

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

割り当て済み

動的

String

externalMemberCount

グループ内の外部ユーザー数

Int

createdOn

グループが作成された日時

DateTime

status

HTTP の応答状態コード

Int

message

エラー メッセージ

String

content

備考です。この要素はこの API で使用されません。既定は “null” が応答されます。

String

nextToken

このリクエストの残りの結果を得るために使用されるトークンです。この要素はこの API で使用されません。既定は “null” が応答されます。

String