group リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
microsoft 365 グループ、Microsoft Teamsのチーム、セキュリティ グループなど、Microsoft Entra グループを表します。 このリソースは、他のプロパティを渡すことができるオープン型です。
directoryObject から継承します。
パフォーマンス上の理由から、作成、取得、一覧表示の操作は、既定ではより一般的に使用されるプロパティのみを返します。 これらの既定のプロパティは、「プロパティ」セクションに記載されています。 既定では返されないプロパティを取得するには、そのプロパティを $select OData クエリ オプションで指定します。
このリソースは以下をサポートしています。
Microsoft Teams と Microsoft 365 グループでは、グループのコラボレーションをサポートします。 Microsoft Teams では、ほとんどの Microsoft 365 グループ API を使用できます。 チーム を作成するには、まず グループを作成 し、それから そのグループにチームを追加 します。 詳細については、「Microsoft Teams 概要」を参照してください。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| List | group コレクション | すべてのグループ オブジェクトのプロパティと関係を読み取ります。 |
| Create | group | 指定されたとおりに新しいグループを作成します。 Microsoft 365 グループ、動的なグループ、セキュリティ グループ、またはチームのいずれかにできます。 |
| Get | group | グループ オブジェクトのプロパティと関係を読み取ります。 |
| Update | なし | グループ オブジェクトのプロパティを更新します。 |
| Delete | なし | グループ オブジェクトを削除します。 |
| Get delta | group コレクション | グループに対する増分の変更を取得します。 |
| Upsert | group | 新しいグループが存在しない場合は作成するか、既存のグループのプロパティを更新します。 |
| グループの管理 | ||
| メンバーを一覧表示する | directoryObject コレクション | members ナビゲーション プロパティからこのグループの直接のメンバーであるユーザーおよびグループを取得します。 |
| メンバーを追加する | directoryObject | メンバー ナビゲーション プロパティ (セキュリティ グループと Microsoft 365 グループでのみサポート) に投稿して、このグループに メンバー を追加します。 |
| メンバーを削除する | なし | メンバーのナビゲーション プロパティを使用して、Microsoft 365 グループまたはセキュリティ グループからメンバーを削除します。 |
| 所有者を一覧表示する | directoryObject コレクション | owners ナビゲーション プロパティからグループの所有者を取得します。 |
| Add owner | directoryObject | owners ナビゲーション プロパティ (セキュリティ グループおよび Microsoft 365 グループのみをサポート) に投稿することによってグループの新規所有者を追加します。 |
| 所有者を削除する | なし | 所有者のナビゲーション プロパティを使用して、Microsoft 365 グループまたはセキュリティ グループから所有者を削除します。 |
| エンドポイントを一覧表示する | endpoint コレクション | endpoint オブジェクトのコレクションを取得します。 |
| エンドポイントを取得する | endpoint | endpoint オブジェクトのプロパティと関係を読み取ります。 |
| 所属を一覧表示する | directoryObject コレクション | このグループが直接のメンバーであるグループおよび管理単位を、memberOf ナビゲーション プロパティから取得します。 |
| グループのライフサイクル ポリシーを一覧表示する | groupLifecyclePolicy コレクション | グループのライフサイクル ポリシーを一覧表示します。 |
| 推移的なメンバーを一覧表示する | directoryObject コレクション | このグループの入れ子になったメンバーを含む、メンバーであるユーザー、グループ、サービス プリンシパルを取得します。 |
| 推移的な所属を一覧表示する | directoryObject コレクション | グループがメンバーになっているグループと管理単位を一覧表示します。 この操作は推移的で、このグループが入れ子のメンバーになっているグループが含まれます。 |
| ライセンスを割り当てる | group | グループのサブスクリプションを追加または削除します。 サブスクリプションに関連付けられている特定のプランを有効または無効にすることもできます。 |
| 動的メンバーシップを評価する | evaluateDynamicMembershipResult | ユーザーまたはデバイスが動的グループのメンバーであるかどうかを評価します。 |
| Renew | ブール型 | グループの有効期限を更新します。 グループが更新されると、グループの有効期限はポリシーで定義された日数、延長されます。 |
| プロパティの検証 | JSON | 名前付けポリシーに準拠する Microsoft 365 グループの表示名またはメール ニックネームを検証します。 |
| App role assignments | ||
| List | appRoleAssignment コレクション | このグループが割り当てられているアプリとアプリロールを取得します。 |
| 追加する | appRoleAssignment | このグループにアプリの役割を割り当てます。 |
| Remove | なし。 | このグループからアプリの役割の割り当てを削除します。 |
| Calendar | ||
| 予定表を取得する | calendar | グループの予定表を取得します。 |
| 予定表を更新する | なし | グループの予定表を更新します。 |
| List events | event コレクション | event オブジェクトのコレクションを取得します。 |
| Create event | event | event コレクションへの投稿によって、新しいイベントを作成します。 |
| イベントを取得する | event | event オブジェクトのプロパティを読み取ります。 |
| イベントを更新する | なし | event オブジェクトのプロパティを更新します。 |
| イベントを削除する | なし | event オブジェクトを削除します。 |
| 予定表ビューを一覧表示する | event コレクション | 指定された時間枠のイベントのコレクションを取得します。 |
| 会話 | ||
| 会話を一覧表示する | conversation コレクション | conversation オブジェクトのコレクションを取得します。 |
| 会話を作成する | conversation | conversation コレクションに投稿して、新しい会話を作成します。 |
| 会話を取得する | conversation | conversation オブジェクトのプロパティを読み取ります。 |
| 会話を削除する | なし | conversation オブジェクトを削除します。 |
| スレッドを一覧表示する | conversationThread コレクション | グループのすべてのスレッドを取得します。 |
| スレッドを作成する | conversationThread | 新しい会話スレッドを作成します。 |
| スレッドを取得する | conversationThread | thread オブジェクトのプロパティを読み取ります。 |
| スレッドを更新する | なし | thread オブジェクトのプロパティを更新します。 |
| スレッドを削除する | なし | thread オブジェクトを削除します |
| 承認済み送信者を一覧表示する | directoryObject コレクション | このグループの許可された送信者リストに含まれるユーザーまたはグループの一覧を取得します。 |
| 承認済み送信者を追加する | directoryObject | acceptSenders コレクションにユーザーまたはグループを追加します。 |
| 承認済み送信者を削除する | directoryObject | acceptedSenders コレクションからユーザーまたはグループを削除します。 |
| 拒否する送信者を一覧表示する | directoryObject collection | このグループの拒否された送信者リストに含まれるユーザーまたはグループの一覧を取得します。 |
| 拒否済み送信者を追加する | directoryObject | rejectedSender コレクションに新しいユーザーまたはグループを追加します。 |
| 拒否済み送信者を削除する | directoryObject | rejectedSender コレクションから新しいユーザーまたはグループを削除します。 |
| ディレクトリ オブジェクト | ||
| 削除済みアイテムの一覧表示 | directoryObject コレクション | 過去 30 日間にテナントで削除されたグループを取得します。 |
| 削除済みアイテムの取得 | directoryObject コレクション | ID で削除されたグループを取得します。 |
| 削除済みアイテムの復元 | directoryObject コレクション | 過去 30 日間にテナントで削除されたグループを復元します。 |
| アイテムを完全に削除する | directoryObject コレクション | テナントから削除されたグループを完全に削除します。 |
| ユーザーによって所有されている削除済みアイテムを一覧表示する | directoryObject コレクション | ユーザーが所有する過去 30 日間にテナントで削除されたグループを取得します。 |
| メンバー グループをチェックする | String collection | グループの一覧内のメンバーシップを確認します。 この関数は推移的です。 |
| メンバー グループを取得する | String collection | グループがメンバーになっているすべてのグループを返します。 この関数は推移的です。 |
| メンバー オブジェクトを確認する | String collection | グループ、ディレクトリ ロール、または管理ユニット オブジェクト一覧内のメンバーシップを確認します。 この関数は推移的です。 |
| メンバー オブジェクトを取得する | String collection | グループがメンバーであるすべてのグループと管理単位を返します。 この関数は推移的です。 |
| Drive | ||
| Get drive | drive | Drive リソースのプロパティと関係を取得します。 |
| 子を一覧表示する | driveItem コレクション | driveItem の子関係にある driveItem オブジェクトのコレクションを返します。 |
| グループ設定 | ||
| List | directorySetting コレクション | すべての設定オブジェクトのプロパティを一覧表示します。 |
| Create | directorySetting | directorySettingTemplate に基づいて設定オブジェクトを作成します。 POST 要求では、テンプレートで定義されているすべての設定に対して settingValues を指定する必要があります。 この操作には、グループ固有のテンプレートのみを使用できます。 |
| Get | directorySetting | 特定の設定オブジェクトのプロパティを参照します。 |
| Update | なし | 設定オブジェクトを更新します。 |
| Delete | なし | 設定オブジェクトを削除します。 |
| リスト設定テンプレート | なし | すべての設定テンプレートを一覧表示します。 |
| 設定テンプレートを取得する | なし | 設定テンプレートのプロパティを読み取ります。 |
| Notes | ||
| List notebooks | notebook コレクション | ノートブック オブジェクトの一覧を取得します。 |
| Create notebook | notebook | 新しい OneNote のノートブックを作成します。 |
| パスワードベースのシングル サインオン資格情報 | ||
| Get | passwordSingleSignOnCredentialSet コレクション | このグループのパスワード ベースのシングル サインオン資格情報の一覧を取得します。 パスワードは返されません。代わりに常に null として返されます。 |
| Delete | なし | このグループに関連付けられている特定のサービス プリンシパルのパスワード ベースのシングル サインオン資格情報を削除します。 |
| 名前。 | ||
| プロフィールの写真 | ||
| Get | profilePhoto | 指定した profilePhoto またはそのメタデータ (profilePhoto プロパティ) を取得します。 |
| Update | なし | サインイン ユーザー、または指定されたグループあるいは連絡先を含むテナント内の任意のユーザーの写真を更新します。 |
| Delete | なし | サインイン ユーザー、または指定されたグループを含むテナント内の任意のユーザーの写真を削除します。 |
| Planner | ||
| 計画を一覧表示する | plannerPlan コレクション | グループに割り当てられたプランを取得します。 |
| Posts | ||
| List | post collection | 会話スレッドの投稿を取得します。 |
| Get | post | 特定の投稿を取得します。 |
| 投稿に返信する | なし | 投稿に返信します。 |
| 投稿を転送する | なし | 投稿を転送します。 |
| その他のグループ リソース | ||
| 権限付与の表示 | resourceSpecificPermissionGrant コレクション | グループにアクセスするためのアプリに付与されるアクセス許可を一覧表示します。 |
| User settings | ||
| お気に入りに追加する | なし | サインインしているユーザーのお気に入りのグループ一覧にグループを追加します。 Microsoft 365 グループでのみサポートされます。 |
| お気に入りを削除する | なし | サインインしているユーザーのお気に入りのグループ一覧からグループを削除します。 Microsoft 365 グループでのみサポートされます。 |
| 所属を一覧表示する | directoryObject コレクション | このユーザーが直接メンバーであるグループと管理単位を memberOf ナビゲーション プロパティから取得します。 |
| 結合されたチームを一覧表示する | group コレクション | ユーザーがダイレクト メンバーになっている Microsoft Teams を取得します。 |
| 関連付けられているチームを一覧表示する | associatedTeamInfo コレクション | ユーザーが関連付けられている Microsoft Teams の associatedTeamInfo オブジェクトの一覧を取得します。 |
| メールで購読する | なし | isSubscribedByMail プロパティを true に設定します。 サインインしているユーザーが電子メールの会話を受信できるようにします。 Microsoft 365 グループでのみサポートされます。 |
| メールでの購読を中止する | なし | isSubscribedByMail プロパティを false に設定します。 サインインしているユーザーがメールの会話を受信できないようにする。 Microsoft 365 グループでのみサポートされます。 |
| 見えないカウントをリセットする | なし | サインインしたユーザーが前回のアクセス以降に表示していないすべての投稿について、unseenCount を 0 にリセットします。 Microsoft 365 グループでのみサポートされます。 |
プロパティ
重要
$filter および $search クエリ パラメーターの具体的な使用方法は、ConsistencyLevel ヘッダーの設定を eventual と $count に使用する場合にのみサポートされます。 詳細については、「ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。
| プロパティ | 型 | 説明 |
|---|---|---|
| accessType | groupAccessType | グループへのアクセスの種類を示します。 使用可能な値は、 none、 private、 secret、および publicです。 |
| allowExternalSenders | Boolean | 組織外部のユーザーがグループにメッセージを送信できるかどうかを示します。 既定値は false です。 $select でのみ返されます。 グループ API を取得 (GET /groups/{ID}) でのみサポートされます。 |
| assignedLabels | assignedLabel コレクション | Microsoft 365 グループに関連付けられている秘密度ラベル ペア (ラベル ID、ラベル名) のリスト。 $select でのみ返されます。 このプロパティは、呼び出し元が Microsoft Graph のアクセス許可と サポートされている管理者ロールの両方を必要とする委任されたシナリオでのみ更新できます。 |
| assignedLicenses | assignedLicense コレクション | グループに割り当てられているライセンス。 $select でのみ返されます。
$filter (eq)をサポートしています。 読み取り専用です。 |
| autoSubscribeNewMembers | Boolean | グループに追加された新しいメンバーが、電子メール通知を受信するために自動サブスクライブされているかどうかを示します。 このプロパティは、グループの PATCH 要求で設定できます。グループを作成する最初の POST 要求では設定しないでください。 既定値は、false です。 $select でのみ返されます。 グループ API を取得 (GET /groups/{ID}) でのみサポートされます。 |
| classification | String | グループの分類 (低、中、高のビジネスへの影響など) について説明します。 このプロパティの有効な値は、テンプレート定義に基づいて ClassificationList 設定値 を作成することによって 定義されます。 既定で返されます。 $filter (eq、ne、not、ge、le、startsWith) をサポートしています。 |
| createdByAppId | String | グループを作成するために使用されたアプリのアプリ ID。 一部のグループに対しては null にすることができます。 既定で返されます。 読み取り専用です。 $filter (eq、ne、not、in、startsWith) をサポートします。 |
| createdDateTime | DateTimeOffset | グループ作成時のタイムスタンプです。 値は変更できません。グループの作成時に自動的に設定されます。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 単位です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 既定で返されます。 読み取り専用です。 |
| deletedDateTime | DateTimeOffset | 一部のMicrosoft Entra オブジェクト (ユーザー、グループ、アプリケーション) では、オブジェクトが削除された場合、最初に論理的に削除され、オブジェクトが削除された日時でこのプロパティが更新されます。 それ以外の場合、このプロパティは null です。 オブジェクトを復元すると、このプロパティは null に更新されます。
directoryObject から継承されます。 |
| 説明 | String | グループに関するオプションの説明。 既定で返されます。 $filter (eq、ne、not、ge、le、startsWith) および $search をサポートしています。 |
| displayName | 文字列 | グループの表示名。 必須です。 最大文字数は 256 文字です。 既定で返されます。 $filter (eq、ne、not、ge、le、in、startsWith、および eq の null値)、$search、および $orderby をサポートします。 |
| expirationDateTime | DateTimeOffset | グループに設定されている有効期限のタイムスタンプです。 セキュリティ グループの場合は null ですが、Microsoft 365 グループの場合は、 groupLifecyclePolicy で定義されているようにグループの有効期限が切れるタイミングを表します。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 単位です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 既定で返されます。 $filter (eq、ne、not、ge、le、in) をサポートしています。 読み取り専用です。 |
| groupTypes | String collection | グループの種類とそのメンバーシップを指定します。 コレクションに Unifiedが含まれている場合、グループは Microsoft 365 グループです。それ以外の場合は、セキュリティ グループまたは配布グループです。 詳しくは、「グループの概要」をご覧ください。DynamicMembershipが含まれている場合、グループは動的メンバーシップがあります。それ以外の場合、メンバーシップは静的です。 既定で返されます。 $filter (eq、not) をサポートしています。 |
| hasMembersWithLicenseErrors | Boolean | このグループの中に、そのグループに基づくライセンス割り当てのライセンス エラーが発生しているメンバーがいるかどうかを示します。 このプロパティは GET 操作では返されません。 これを $ filter 引数として使用して、ライセンス エラーが発生しているメンバーがいるグループを取得できます (つまり、このプロパティが true であるフィルターです)。 $filter (eq)をサポートしています。 |
| hideFromAddressLists | ブール型 |
trueグループが Outlook ユーザー インターフェイスの特定の部分に表示されない場合は、アドレス帳、メッセージ受信者を選択するためのアドレス一覧、グループを検索するための [グループ参照] ダイアログ、それ以外の場合は false。 既定値は false です。 $select でのみ返されます。 グループ API を取得 (GET /groups/{ID}) でのみサポートされます。 |
| hideFromOutlookClients | ブール型 |
trueOutlook for Windows や Outlook on the web などの Outlook クライアントにグループが表示されない場合は、それ以外の場合は false。 既定値は false です。 $select でのみ返されます。 グループ API を取得 (GET /groups/{ID}) でのみサポートされます。 |
| id | String | グループの一意の識別子。 既定で返されます。 directoryObject から継承されます。 キー。 null 許容ではありません。 読み取り専用です。 $filter (eq、ne、not、in) をサポートします。 |
| isArchived | Boolean | グループがチームに関連付けられている場合、このプロパティは、チームが読み取り専用モードであるかどうかを判断します。 このプロパティを読み取るには、 /group/{groupId}/team エンドポイントまたは Get team API を使用します。 このプロパティを更新するには、archiveTeam API と unarchiveTeam API を使用します。 |
| isAssignableToRole | ブール値 | このグループをMicrosoft Entraロールに割り当てることができるかどうかを示します。 省略可能。 このプロパティは、グループの作成時にのみ設定でき、変更できません。 trueに設定する場合は、securityEnabled プロパティも true に設定する必要があります。可視性をHiddenする必要があります。また、グループを動的グループにすることはできません (つまり、groupTypes にDynamicMembershipを含めることはできません)。 このプロパティを設定できるのは、少なくとも特権ロール管理者ロールを持つ呼び出し元のみです。 このプロパティを設定したり、そのようなグループのメンバーシップを更新したりするには、呼び出し元に RoleManagement.ReadWrite.Directory 権限も割り当てる必要があります。 詳細については、「グループを使用してMicrosoft Entraロールの割り当てを管理する」を参照してください。 この機能を使用するには、Microsoft Entra ID P1 ライセンスが必要です。 既定で返されます。 $filter (eq、ne、not) をサポートします。 |
| isFavorite | Boolean | ユーザーがグループをお気に入りとしてマークしたかどうかを示します。 |
| isManagementRestricted | ブール型 | グループが制限付き管理管理単位のメンバーであるかどうかを示します。 既定値は false です。 読み取り専用です。 制限付き管理管理単位のグループ メンバーを管理するには、管理者または呼び出し元アプリに、制限付き管理管理単位のスコープでMicrosoft Entraロールを割り当てる必要があります。 |
| infoCatalogs | String コレクション | グループに割り当てられた情報セグメントを示します。 既定で返されます。
$filter (eq、not、ge、le、startsWith) をサポートしています。 |
| isSubscribedByMail | Boolean | サインインしているユーザーが電子メールの会話を受信するように登録されているかどうかを示します。 既定値は true です。 $select でのみ返されます。 グループ API を取得 (GET /groups/{ID}) でのみサポートされます。 |
| licenseProcessingState | String | すべてのグループ メンバーに対するグループ ライセンスの割り当ての状態を示します。 使用可能な値: QueuedForProcessing、ProcessingInProgress、ProcessingComplete。 $select でのみ返されます。 読み取り専用です。 |
| String | グループの SMTP アドレス ("serviceadmins@contoso.com" など)。 既定で返されます。 読み取り専用です。 $filter (eq、 ne、 not、 ge、 le、 in、 startsWith と eq の null値) をサポートします。 |
|
| mailEnabled | ブール値 | メールが有効なグループであるかどうかを指定します。 必須です。 既定で返されます。 $filter (eq、ne、not、および eq の null 値) をサポートします。 |
| mailNickname | String | 組織内の Microsoft 365 グループに対して一意の、グループのメール エイリアス。 最大文字数は 64 文字です。 このプロパティには、 ASCII 文字セット 0 ~ 127 の文字のみを含めることができます。ただし、以下の @ () \ [] " ; : <> , SPACEを除いたものです。 既定で返されます。 $filter (eq、ne、not、ge、le、in、startsWith) をサポートします。 |
| membershipRule | String | グループが動的なグループの場合 (groupTypes に DynamicMembership が含まれる) に、このグループのメンバーを決定する規則です。 メンバーシップの規則の構文の詳細については、「メンバーシップの規則の構文」を参照してください。 既定で返されます。 $filter (eq、ne、not、ge、le、startsWith) をサポートしています。 |
| membershipRuleProcessingState | String | 動的メンバーシップの処理が進行中か、または一時停止しているかどうかを示します。 使用可能な値は On または Paused です。 既定で返されます。 $filter (eq、ne、not、in) をサポートします。 |
| membershipRuleProcessingStatus | membershipRuleProcessingStatus | ルールベースの動的グループの処理状態について説明します。 プロパティは、ルール ベースではない動的グループの場合、または動的グループの処理が一時停止されている場合に null されます。 $select でのみ返されます。 グループ API を取得 (GET /groups/{ID}) でのみサポートされます。 読み取り専用です。 |
| onPremisesDomainName | String | オンプレミス ディレクトリから同期されたオンプレミスのドメイン FQDN (dnsDomainName とも呼ばれます) が含まれています。 このプロパティは、オンプレミス ディレクトリを Microsoft Entra Connect 経由で Microsoft Entra ID と同期する顧客の場合にのみ読み込まれます。 既定で返されます。 読み取り専用。 |
| onPremisesLastSyncDateTime | DateTimeOffset | グループがオンプレミス ディレクトリと同期された最後の時刻を示します。Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC で表されます。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 既定で返されます。 読み取り専用です。 $filter (eq、ne、not、ge、le、in) をサポートします。 |
| onPremisesNetBiosName | String | オンプレミス ディレクトリから同期されたオンプレミスの netBios name が含まれています。 このプロパティは、オンプレミス ディレクトリを Microsoft Entra Connect 経由で Microsoft Entra ID と同期する顧客の場合にのみ読み込まれます。 既定で返されます。 読み取り専用です。 |
| onPremisesProvisioningErrors | onPremisesProvisioningError コレクション | Microsoft 同期製品のプロビジョニング中に発生するエラーです。 既定で返されます。 $filter (eq、not) をサポートしています。 |
| onPremisesSamAccountName | 文字列 | オンプレミス ディレクトリから同期されたオンプレミスの SAM アカウント名が含まれています。 このプロパティは、オンプレミス ディレクトリを Microsoft Entra Connect 経由で Microsoft Entra ID と同期する顧客の場合にのみ読み込まれます。 既定で返されます。 $filter (eq、ne、not、ge、le、in、startsWith) をサポートします。 読み取り専用です。 |
| onPremisesSecurityIdentifier | String | オンプレミスからクラウドに同期されるグループのオンプレミス セキュリティ識別子 (SID) が含まれます。 読み取り専用です。 既定で返されます。 $filter をサポートします (null 値を含む eq)。 |
| onPremisesSyncEnabled | Boolean | このグループがオンプレミスのディレクトリから同期される場合は true、このグループが最初にオンプレミスのディレクトリから同期されていて、今後は同期しない場合は false、このオブジェクトがオンプレミスのディレクトリから一度も同期されたことがない場合は null。 既定で返されます。 読み取り専用です。 $filter (eq、ne、not、in、および eq の null 値) をサポートします。 |
| preferredDataLocation | String | Microsoft 365 グループのデータの優先される場所。 既定では、グループはグループ作成者が優先するデータの場所を継承します。 このプロパティを設定するには、呼び出し元のアプリに Directory.ReadWrite.All アクセス許可を付与し、ユーザーに次のMicrosoft Entraロールの少なくとも 1 つを割り当てる必要があります。
このプロパティの詳細については、「 OneDrive Online Multi-Geo 」および「 特定の PDL を使用して Microsoft 365 グループを作成する」を参照してください。 Null 許容型です。 既定で返されます。 |
| preferredLanguage | 文字列 | Microsoft 365 グループで優先する言語。 ISO 639-1 コードに従う必要があります (例: en-US)。 既定で返されます。 $filter (eq、 ne、 not、 ge、 le、 in、 startsWith と eq の null値) をサポートします。 |
| proxyAddresses | String コレクション | 同じグループ メールボックスに送信されるグループのメール アドレスです。 例: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]。 複数値プロパティのフィルター式には any 演算子が必要です。 既定で返されます。 読み取り専用です。 null 許容ではありません。 $filter (eq、not、ge、le、startsWith、endsWith、/$count eq 0、/$count ne 0) をサポートします。 |
| renewedDateTime | DateTimeOffset | グループの最後の更新時のタイムスタンプです。 これは直接変更することはできず、更新サービス アクション経由でのみ更新されます。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 単位です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 既定で返されます。 $filter (eq、ne、not、ge、le、in) をサポートしています。 読み取り専用。 |
| resourceBehaviorOptions | String コレクション | 作成中に Microsoft 365 グループに設定できるグループ動作を指定します。 このプロパティは、作成 (POST) の一部としてのみ設定できます。 使用可能な値の一覧については、「 Microsoft 365 グループの動作とプロビジョニング オプション」を参照してください。 |
| resourceProvisioningOptions | String コレクション | Microsoft 365 グループに関連付けられているグループ リソースを指定します。 使用可能な値は Team。 詳細については、「 Microsoft 365 グループの動作とプロビジョニング オプション」を参照してください。 既定で返されます。 $filter (eq, not, startsWith. をサポートしています。 |
| securityEnabled | ブール値 | グループがセキュリティ グループであるかどうかを指定します。 必須です。 既定で返されます。 $filter (eq、ne、not、in) をサポートします。 |
| securityIdentifier | 文字列 | Windows シナリオで使用されるグループのセキュリティ識別子。 読み取り専用です。 既定で返されます。 |
| serviceProvisioningErrors | serviceProvisioningError コレクション | グループ オブジェクトからのプロパティまたはリンクに関する一時的でないサービス固有のエラーを記述するフェデレーション サービスによって発行されたエラー。 |
| theme | 文字列 | Microsoft 365 グループの色のテーマを指定します。 可能な値: Teal、Purple、Green、Blue、Pink、Orange、Red。 既定で返されます。 |
| uniqueName | String | グループに割り当て、代替キーとして使用できる一意の識別子。 不変です。 読み取り専用です。 |
| unseenConversationsCount | Int32 | サインインしたユーザーがグループに最後にアクセスしてから、1 つ以上の新しい投稿が配信された会話の数。 このプロパティは、unseenCount と同じです。 $select でのみ返されます。 |
| unseenCount | Int32 | サインにしているユーザーのグループへの最後のアクセス以降に新しい投稿を受け取った会話の数です。 このプロパティは、unseenConversationsCount と同じです。$select でのみ返されます。 グループ API を取得 (GET /groups/{ID}) でのみサポートされます。 |
| unseenMessagesCount | Int32 | サインイン ユーザーのグループへの最後のアクセス以降に、グループの会話に配信された新しい投稿のカウントです。 $select でのみ返されます。 |
| visibility | String | グループのグループ参加ポリシーとグループ コンテンツの可視性を指定します。 使用可能な値は、Private、Public、HiddenMembership です。
HiddenMembership は、グループの作成時に Microsoft 365 グループにのみ設定できます。 後で更新することはできません。 可視性の他の値は、グループの作成後に更新できます。Microsoft Graph でのグループの作成時に可視性の値が指定されていない場合、セキュリティ グループは既定で Private として作成され、Microsoft 365 グループは Publicされます。 役割に割り当て可能なグループは常に Private です。 詳細については、「 グループの表示オプション」を参照してください。 既定で返されます。 Null 許容型。 |
| writebackConfiguration | groupWritebackConfiguration | グループ オブジェクトのプロパティをオンプレミスの Active Directoryに書き戻すグループを構成するかどうかを指定します。 これらのプロパティは、Microsoft Entra Connect 同期クライアントでグループ ライトバックが構成されている場合に使用されます。 |
グループの表示オプション
| 値 | 説明 |
|---|---|
| パブリック | 所有者のアクセス許可がなくても、すべてのユーザーがグループに参加できます。 グループの内容は誰でも表示できます。 |
| プライベート | グループに参加するには、所有者のアクセス許可が必要です。 メンバー以外はグループのコンテンツを読むことができません。 |
| Hiddenmembership | グループに参加するには、所有者のアクセス許可が必要です。 メンバー以外はグループのコンテンツを読むことができません。 メンバー以外はグループのメンバーを確認することができません。 管理者 (グローバル、会社、ユーザー、ヘルプデスク) が、グループのメンバーシップを参照できます。 グループは、グローバル アドレス帳 (GAL) に表示されます。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| acceptedSenders | directoryObject コレクション | このグループに投稿または予定表イベントを作成できるユーザーまたはグループの一覧。 このリストが空でない場合は、ここに一覧表示されているユーザーまたはグループのみが投稿できます。 |
| appRoleAssignments | appRoleAssignment コレクション | グループがアプリに対して付与されているアプリの役割を表します。
$expand をサポートします。 |
| 予定表 | calendar | グループの予定表。 読み取り専用です。 |
| calendarView | event コレクション | 予定表のカレンダー ビュー。 読み取り専用です。 |
| conversations | conversation コレクション | グループの会話。 |
| createdOnBehalfOf | directoryObject | グループを作成したユーザー (またはアプリケーション)。 手記： ユーザーが管理者の場合、これは設定されません。 読み取り専用。 |
| drive | drive | グループの既定のドライブ。 読み取り専用です。 |
| drives | drive コレクション | グループのドライブ。 読み取り専用です。 |
| endpoints | Endpoint collection | グループのエンドポイント。 読み取り専用です。 Null 許容型。 |
| events | event コレクション | グループのイベント。 |
| extensions | extension コレクション | グループに対して定義されている開いている拡張機能のコレクション。 読み取り専用です。 Null 許容型です。 |
| groupLifecyclePolicies | groupLifecyclePolicy コレクション | このグループのライフ サイクル ポリシーのコレクション。 読み取り専用です。 Null 許容型。 |
| memberOf | directoryObject コレクション | グループがメンバーになっているグループと管理単位です。 HTTP メソッド: GET (すべてのグループでサポートされます)。 読み取り専用です。 Null 許容型です。
$expand をサポートします。 |
| members | directoryObject コレクション | 直接グループ メンバー。ユーザー、デバイス、その他のグループ、またはサービス プリンシパルを指定できます。
メンバーのリスト、メンバーの追加、およびメンバーの削除の操作をサポートします。 Null 許容型。 入れ子になった $select を含む $expand をサポートします。 たとえば、「 /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName) 」のように入力します。 |
| membersWithLicenseErrors | user コレクション | このグループに基づくライセンスの割り当てからのライセンス エラーが発生しているグループ メンバーの一覧です。 読み取り専用です。 |
| onenote | onenote | 読み取り専用です。 |
| owners | directoryObject コレクション | ユーザーまたはサービス プリンシパルになることができるグループの所有者。 100 人の所有者に制限されます。 Null 許容型。 $filter (/$count eq 0、/$count ne 0、/$count eq 1、/$count ne 1) をサポートします。入れ子になった$selectを含む$expandをサポートします。 たとえば、「 /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName) 」のように入力します。 |
| permissionGrants | resourceSpecificPermissionGrant | 特定のアプリケーションに対してグループに付与されるアクセス許可。
$expand をサポートします。 |
| photo | profilePhoto | グループのプロファイル写真。 |
| photos | profilePhoto コレクション | グループが所有するプロフィール写真。 読み取り専用です。 Null 許容型です。 |
| planner | plannerGroup | グループで使用可能な選択的プランナー サービス。 読み取り専用です。 Null 許容型。 |
| rejectedSenders | directoryObject コレクション | このグループに投稿または予定表イベントを作成できないユーザーまたはグループの一覧。 Nullable |
| 設定 | directorySetting コレクション | メンバーがゲスト ユーザーをグループに招待できるかどうかなどのグループの動作を管理する設定。 Null 許容型。 |
| sites | site コレクション | このグループ内の SharePoint サイトの一覧。 /sites/root を使用して既定のサイトにアクセスします。 |
| team | channel コレクション | このグループに関連付けられているチーム。 |
| threads | conversationThread コレクション | グループの会話スレッド。 Null 許容型です。 |
| transitiveMemberOf | directoryObject コレクション | グループがメンバーであるグループは、直接または入れ子になったメンバーシップを介して行います。 Null 許容型。 |
| transitiveMembers | directoryObject コレクション | グループの直接および推移的なメンバー。 Null 許容型。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"accessType": "String",
"assignedLabels": [{ "@odata.type": "microsoft.graph.assignedLabel" }],
"assignedLicenses": [{ "@odata.type": "microsoft.graph.assignedLicense" }],
"allowExternalSenders": false,
"autoSubscribeNewMembers": true,
"createdByAppId": "String",
"createdDateTime": "String (timestamp)",
"deletedDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"expirationDateTime": "String (timestamp)",
"groupTypes": ["String"],
"hideFromAddressLists": false,
"hideFromOutlookClients": false,
"id": "String (identifier)",
"isFavorite": true,
"isArchived": false,
"isAssignableToRole": false,
"isSubscribedByMail": true,
"licenseProcessingState": "String",
"mail": "String",
"mailEnabled": true,
"mailNickname": "String",
"onPremisesDomainName": "String",
"onPremisesLastSyncDateTime": "String (timestamp)",
"onPremisesNetBiosName": "String",
"onPremisesProvisioningErrors": [
{ "@odata.type": "microsoft.graph.onPremisesProvisioningError" }
],
"onPremisesSamAccountName": "String",
"onPremisesSecurityIdentifier": "String",
"onPremisesSyncEnabled": true,
"preferredDataLocation": "String",
"proxyAddresses": ["String"],
"renewedDateTime": "String (timestamp)",
"resourceBehaviorOptions": ["String"],
"resourceProvisioningOptions": ["String"],
"securityEnabled": true,
"securityIdentifier": "String",
"serviceProvisioningErrors": [
{ "@odata.type": "microsoft.graph.serviceProvisioningXmlError" }
],
"uniqueName": "String",
"unseenConversationsCount": 1024,
"unseenCount": 1024,
"unseenMessagesCount": 1024,
"visibility": "String",
"acceptedSenders": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"calendar": { "@odata.type": "microsoft.graph.calendar" },
"calendarView": [{ "@odata.type": "microsoft.graph.event" }],
"conversations": [{ "@odata.type": "microsoft.graph.conversation" }],
"createdOnBehalfOf": { "@odata.type": "microsoft.graph.directoryObject" },
"drive": { "@odata.type": "microsoft.graph.drive" },
"events": [{ "@odata.type": "microsoft.graph.event" }],
"memberOf": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"members": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"membersWithLicenseErrors": [{ "@odata.type": "microsoft.graph.user" }],
"owners": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"photo": { "@odata.type": "microsoft.graph.profilePhoto" },
"photos": [{ "@odata.type": "microsoft.graph.profilePhoto" }],
"rejectedSenders": [{ "@odata.type": "microsoft.graph.directoryObject" }],
"sites": [{ "@odata.type": "microsoft.graph.site" }],
"threads": [{ "@odata.type": "microsoft.graph.conversationThread" }],
"classification": "String",
"hasMembersWithLicenseErrors": true,
"membershipRule": "String",
"membershipRuleProcessingState": "String",
"membershipRuleProcessingStatus": {
"@odata.type": "microsoft.graph.membershipRuleProcessingStatus"
},
"preferredLanguage": "String",
"theme": "String"
}