グループを更新するUpdate group

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

グループオブジェクトのプロパティを更新します。Update the properties of a group object.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Group.ReadWrite.All、Directory.ReadWrite.All、Directory.AccessAsUser.AllGroup.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication Group.ReadWrite.All、Directory.ReadWrite.AllGroup.ReadWrite.All, Directory.ReadWrite.All

HTTP 要求HTTP request

PATCH /groups/{id}

要求ヘッダーRequest headers

名前Name Type 説明Description
AuthorizationAuthorization stringstring ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文Request body

要求本文で、更新する関連フィールドの値を指定します。要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。最適なパフォーマンスを得るためには、変更されていない既存の値を含めないでください。In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

プロパティProperty Type 説明Description
allowExternalSendersallowExternalSenders BooleanBoolean 既定値は false です。組織外部のユーザーがグループにメッセージを送信できるかどうかを示します。Default is false. Indicates if people external to the organization can send messages to the group.
autoSubscribeNewMembersautoSubscribeNewMembers BooleanBoolean 既定値は false です。グループに追加された新しいメンバーが、電子メールの通知を受信するように自動的にサブスクライブされるかどうかを示します。Default is false. Indicates if new members added to the group will be auto-subscribed to receive email notifications.
descriptiondescription StringString グループに関するオプションの説明。An optional description for the group.
displayNamedisplayName StringString グループの表示名。The display name for the group. このプロパティは、グループの作成時の必須プロパティであり、更新時にクリアすることはできません。This property is required when a group is created and it cannot be cleared during updates.
groupTypesgroupTypes String collectionString collection グループの種類とそのメンバーシップを指定します。Specifies the group type and its membership.

コレクションが統合されている場合、グループは Office 365 グループです。それ以外の場合は、セキュリティグループです。If the collection contains Unified then the group is an Office 365 group; otherwise it's a security group.

コレクションにDynamicmembershipが含まれている場合、そのグループには動的メンバーシップがあります。それ以外の場合、メンバーシップは静的です。If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static.
mailEnabledmailEnabled BooleanBoolean メールが有効なグループであるかどうかを指定します。securityEnabled プロパティも true の場合、グループはメールが有効なセキュリティ グループになります。Specifies whether the group is mail-enabled.
mailNicknamemailNickname StringString グループの電子メール エイリアス。The mail alias for the group. このプロパティは、グループの作成時に指定する必要があります。This property must be specified when a group is created.
securityEnabledsecurityEnabled BooleanBoolean グループが Office 365 グループを含むセキュリティグループであるかどうかを指定します。Specifies whether the group is a security group, including Office 365 groups.
visibilityvisibility StringString Office 365 グループの表示を指定します。使用可能な値は次のとおりです。PrivatePublic、または空 (Public として解釈されます)。Specifies the visibility of an Office 365 group. Possible values are: Private, Public, or empty (which is interpreted as Public).

グループリソースは拡張機能をサポートしているためPATCH 、操作を使用して、既存のグループインスタンスの拡張機能のカスタムプロパティで、独自のアプリ固有のデータを追加、更新、または削除することができます。Because the group resource supports extensions, you can use the PATCH operation to add, update, or delete your own app-specific data in custom properties of an extension in an existing group instance.

注意: Note:

  • autoSubscribeNewMembers は、独自の PATCH 要求で指定することによって更新できます。上の表にある他のプロパティは含めません。You can update autoSubscribeNewMembers by specifying it in its own PATCH request, without including the other properties in the table above.
  • コア グループの管理とマネージメントに関するグループ API のサブセットのみが、アプリケーションのアクセス許可と委任されたアクセス許可をサポートします。autoSubscribeNewMembers の更新を含む他のすべてのグループ API のメンバーは、委任されたアクセス許可のみをサポートします。例については、「既知の問題」を参照してください。Only a subset of the group API pertaining to core group administration and management support application and delegated permissions. All other members of the group API, including updating autoSubscribeNewMembers, support only delegated permissions. See known issues for examples.
  • Microsoft Exchange Server でメールが有効なセキュリティグループを更新するためのルールは複雑になることがあります。詳細については、「 Exchange Server でメールが有効なセキュリティグループを管理する」を参照してください。The rules for updating mail-enabled security groups in Microsoft Exchange Server can be complex; to learn more, see Manage mail-enabled security groups in Exchange Server.

応答Response

成功した場合、このメソッドは 204 No Content 応答コードを返します。If successful, this method returns a 204 No Content response code.

Example

要求Request

要求の例を次に示します。The following is an example of the request.

PATCH https://graph.microsoft.com/beta/groups/{id}
Content-type: application/json
Content-length: 211

{
  "description": "description-value",
  "displayName": "displayName-value",
  "groupTypes": [
    "groupTypes-value"
  ],
  "mail": "mail-value",
  "mailEnabled": true,
  "mailNickname": "mailNickname-value"
}

応答Response

応答の例を次に示します。The following is an example of the response.

HTTP/1.1 204 No Content

関連項目See also