次の方法で共有


グループを更新する

名前空間: microsoft.graph

グループ オブジェクトのプロパティを更新します。

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

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

アクセス許可

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

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

HTTP 要求

PATCH /groups/{id}

要求ヘッダー

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

要求本文

要求本文で、更新すべきプロパティの値のみを指定します。 要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

プロパティ 種類 説明
allowExternalSenders Boolean 既定値は false です。 組織外部のユーザーがグループにメッセージを送信できるかどうかを示します。
assignedLabels assignedLabel コレクション Microsoft 365 グループに関連付けられている秘密度ラベル ペア (ラベル ID、ラベル名) のリスト。
autoSubscribeNewMembers Boolean 既定値は false です。 グループに追加された新しいメンバーが、電子メールの通知を受信するように自動的にサブスクライブされるかどうかを示します。 グループで subscriptionEnabledfalse に設定されている場合、autoSubscribeNewMemberstrue になることができません。
説明 String グループに関するオプションの説明。
displayName 文字列 グループの表示名。 このプロパティは、グループの作成時の必須プロパティであり、更新時にクリアすることはできません。
mailNickname String 組織内の Microsoft 365 グループに対して一意の、グループのメール エイリアス。 最大文字数は 64 文字です。 このプロパティには、 ASCII 文字セット 0 ~ 127 の文字のみを含めることができます。ただし、以下の @ () \ [] " ; : . <> , SPACEを除いたものです。
preferredDataLocation String Microsoft 365 グループのデータの優先される場所。 このプロパティを更新するには、呼び出し元のユーザーに、次の Microsoft Entra ロールの少なくとも 1 つを割り当てる必要があります。
  • ユーザー アカウント管理者
  • ディレクトリ ライター
  • Exchange 管理者
  • SharePoint 管理者

このプロパティの詳細については、「OneDrive Online Multi-Geo」 を参照してください。
securityEnabled ブール値 グループがセキュリティ グループであるかどうかを指定します。
uniqueName String グループに割り当て、代替キーとして使用できる一意の識別子。 nullし、一度設定すると変更できない場合にのみ更新できます。
visibility String Microsoft 365 グループの表示を指定します。 可能な値は以下のどれかです: PrivatePublicまたは empty (これは Publicと解釈されます)。

重要

  • 次のプロパティを更新するには、前の表に示した他のプロパティを含めずに、独自の PATCH 要求で指定する必要があります。 allowExternalSendersautoSubscribeNewMembershideFromAddressListshideFromOutlookClientsisSubscribedByMailunseenCount
  • コア グループの管理と管理に関連するグループ API のサブセットのみが、アプリケーションと委任されたアクセス許可をサポートします。 autoSubscribeNewMembers の更新など、グループ API の他のすべてのメンバーは、委任されたアクセス許可のみをサポートします。
  • Microsoft Exchange Server でメールが有効なセキュリティ グループを更新するためのルールが複雑になる場合があります。詳細については、「Exchange Server でメールが有効なセキュリティ グループを管理する」を参照してください。
  • assignedLabels を更新する場合、アプリケーションのアクセス許可はサポートされません。

拡張機能と関連データを管理する

次のように、この API を使用して、ディレクトリ、スキーマ、およびユーザーのオープン拡張機能 とそのデータを管理します。

  • 既存のユーザーの拡張機能にデータを追加、更新、および格納します。
  • ディレクトリおよびスキーマ拡張機能の場合は、カスタム拡張プロパティの値を null に設定して、格納されているデータをすべて削除します。 オープン拡張機能の場合は、[オープン拡張機能を削除する] API を使用します。

応答

成功した場合は、 このメソッドは 204 No Content 応答コードを返します。ただし、次のプロパティを更新する場合は、200 OK 応答コードを除きます: allowExternalSendersautoSubscribeNewMembershideFromAddressListshideFromOutlookClientsisSubscribedByMailunseenCount

次の例は、グループを更新する方法を示しています。

要求

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

PATCH https://graph.microsoft.com/v1.0/groups/0d09007d-45b2-458c-b180-880dde3a302e
Content-type: application/json

{
  "description": "Library Assist - ADC",
  "displayName": "Library Assist - ADC",
  "mailNickname": "library-help-adc"
}

応答

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

HTTP/1.1 204 No Content