ownerlessGroupPolicy を作成または更新する

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

テナントの ownerlessGroupPolicy を作成または更新します。 ポリシーが存在しない場合は、新しいポリシーが作成されます。ポリシーが存在する場合は、既存のポリシーを更新します。

ポリシーを無効にするには、 isEnabledfalse に設定します。 isEnabledfalse に設定すると、他のすべてのポリシー パラメーターの値がクリアされます。

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

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

アクセス許可

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

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

重要

委任されたシナリオでは、呼び出し元のユーザーにグループ管理者または Exchange 管理者Microsoft Entraロールを割り当てる必要があります。

HTTP 要求

PATCH /policies/ownerlessGroupPolicy

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、 ownerlessGroupPolicy オブジェクトの JSON 表現を指定します。 作成操作の場合や、ポリシーを有効にしたり構成を変更したりする更新操作の場合は、API がポリシー構成の完全な置換を実行するため、必要なすべてのプロパティを指定する必要があります。 ポリシーを無効にするには、 isEnabledfalse に設定するだけで送信できます。送信すると、その他のすべてのポリシー パラメーターの値がクリアされます。 管理ポータルとは異なり、API では、 targetOwners を除き、ほとんどのプロパティに既定値は適用されません。既定では、すべてのメンバーが所有者になることを許可します。

プロパティ 説明
emailInfo emailDetails 所有者なしグループ ポリシーの電子メール通知の詳細。 ポリシーを作成するとき、またはポリシー構成を有効または更新するときに必要です。
enabledGroupIds String collection ポリシーが有効になっている Microsoft 365 グループの ID のコレクション。 空の場合、テナント内のすべてのグループに対してポリシーが有効になります。 ポリシーを作成するとき、またはポリシー構成を有効または更新するときに必要です。
isEnabled ブール値 所有者なしのグループ ポリシーが有効かどうかを示します。 必須です。 このプロパティを false に設定すると、他のすべてのポリシー パラメーターの値がクリアされます。ポリシーを無効にするには、このプロパティのみを値 falseで送信できます。
maxMembersToNotify Int64 通知するメンバーの最大数。 値の範囲は 0 から 90 です。 ポリシーを作成するとき、またはポリシー構成を有効または更新するときに必要です。
notificationDurationInWeeks Int64 通知期間の週数。 値の範囲は 1 から 7 です。 ポリシーを作成するとき、またはポリシー構成を有効または更新するときに必要です。
policyWebUrl 文字列 ポリシー ドキュメントの URL。 省略可能。
targetOwners targetOwners 所有者になる資格のあるメンバーを指定します。 指定しない場合、すべてのメンバーが対象となります。 省略可能。

応答

成功した場合、このメソッドは、ポリシーが既に存在する場合は応答本文に 200 OK 応答コードと更新された ownerlessGroupPolicy オブジェクト、またはポリシーの作成時に応答本文に 201 Created 応答コードと新しい ownerlessGroupPolicy オブジェクトを返します。

エラー

条件 状態コード エラー コード
notificationDurationInWeeks が 1 から 7 の範囲にありません 400 無効な要求 badRequest
maxMembersToNotify が 0 から 90 の範囲にありません 400 無効な要求 badRequest

例 1: 所有者なしのグループ ポリシーを作成または更新する

要求

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

PATCH https://graph.microsoft.com/beta/policies/ownerlessGroupPolicy
Content-Type: application/json

{
  "isEnabled": true,
  "notificationDurationInWeeks": 3,
  "maxMembersToNotify": 40,
  "policyWebUrl": "https://contoso.com/policies/ownerless-groups",
  "targetOwners": {
    "notifyMembers": "allowSelected",
    "securityGroups": [
      "security-group1@contoso.com",
      "security-group2@contoso.com"
    ]
  },
  "enabledGroupIds": [
    "b14e5eb2-a0a1-4c8f-b83e-940526219200",
    "454dde77-ac2b-421b-a6ab-165be910e0fc"
  ],
  "emailInfo": {
    "senderEmailAddress": "admin@contoso.com",
    "subject": "Need your help with $Group.Name group",
    "body": "Hi $User.DisplayName, \n\nYou'\''re receiving this email because you'\''ve been an active member of the $Group.Name group. This group currently does not have an owner. \n\nPer your organization'\''s policy, the group requires an owner.\n\nThank you"
  }
}

応答

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

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.ownerlessGroupPolicy",
  "isEnabled": true,
  "notificationDurationInWeeks": 3,
  "maxMembersToNotify": 40,
  "enabledGroupIds": [
    "b14e5eb2-a0a1-4c8f-b83e-940526219200",
    "454dde77-ac2b-421b-a6ab-165be910e0fc"
  ],
  "emailInfo": {
    "@odata.type": "microsoft.graph.emailDetails",
    "senderEmailAddress": "admin@contoso.com",
    "subject": "Need your help with $Group.Name group",
    "body": "Hi $User.DisplayName, \n\nYou'\''re receiving this email because you'\''ve been an active member of the $Group.Name group. This group currently does not have an owner. \n\nPer your organization'\''s policy, the group requires an owner.\n\nThank you"
  },
  "policyWebUrl": "https://contoso.com/policies/ownerless-groups",
  "targetOwners": {
    "@odata.type": "microsoft.graph.targetOwners",
    "notifyMembers": "allowSelected",
    "securityGroups": [
      "security-group1@contoso.com",
      "security-group2@contoso.com"
    ]
  }
}

例 2: 所有者なしのグループ ポリシーを無効にする

要求

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

PATCH https://graph.microsoft.com/beta/policies/ownerlessGroupPolicy
Content-Type: application/json

{
  "isEnabled": false
}

応答

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.ownerlessGroupPolicy",
  "isEnabled": false,
  "notificationDurationInWeeks": 0,
  "maxMembersToNotify": 0,
  "enabledGroupIds": [],
  "emailInfo": {
    "@odata.type": "microsoft.graph.emailDetails",
    "senderEmailAddress": "",
    "subject": "",
    "body": ""
  },
  "policyWebUrl": "",
  "targetOwners": {
    "@odata.type": "microsoft.graph.targetOwners",
    "notifyMembers": "all",
    "securityGroups": []
  }
}