メンバーを追加する

名前空間: microsoft.graph

重要

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

この API を使用して、管理単位にメンバー (ユーザー、グループ、またはデバイス) を追加したり、管理単位内に新しいグループを作成したりします。 すべての グループの種類 は、管理単位内に作成できます。

メモ: 現在、管理単位には一度に 1 人のメンバーしか追加できません。」

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

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

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

既存のユーザー、グループ、またはデバイスを追加する権限

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) AdministrativeUnit.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。
アプリケーション AdministrativeUnit.ReadWrite.All

重要

職場または学校アカウントを使用してアクセスを委任する場合、サインインしたユーザーがメンバー ユーザーであるか、サポートされている Microsoft Entra ロール、またはこの操作に必要なアクセス許可を付与するカスタム ロールが割り当てられている必要があります。 s特権ロール管理者 は、この操作でサポートされる最小特権ロールです。

新しいグループを作成するためのアクセス許可

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) Group.ReadWrite.All and AdministrativeUnit.Read.All, Directory.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。
アプリケーション Group.Create と AdministrativeUnit.Read.All、Group.ReadWrite.All と AdministrativeUnit.Read.All、Directory.ReadWrite.All

重要

管理単位に新しいグループを作成するには、呼び出し元プリンシパルに、管理単位の範囲で次の Microsoft Entra ロールの少なくとも 1 つが割り当てられている必要があります。

  • グループ管理者
  • ユーザー管理者

アプリのみのシナリオの場合 - これらの役割とは別に、サービス プリンシパルにはディレクトリを読み取るための追加のアクセス許可が必要です。 これらのアクセス許可は、ディレクトリ閲覧者ロールなどのサポートされている Microsoft Entra ロールの割り当てによって付与できます。または、ディレクトリの読み取りを許可する Directory.Read.All などの Microsoft Graph アプリケーションのアクセス許可を介して付与することもできます。

HTTP 要求

次の要求では、既存のユーザー、グループ、またはデバイスが管理単位に追加されます。

POST /administrativeUnits/{id}/members/$ref

次の要求は、管理単位内に新しいグループを作成します。

POST /administrativeUnits/{id}/members

要求ヘッダー

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

既存のユーザーまたはグループを追加する

リクエストの本文には、追加する ユーザー、 グループ、 デバイス、 またはディレクトリ オブジェクト の ID を指定します。 管理単位が制限付き管理管理単位 ("isMemberManagementRestricted": true) の場合、グループの種類はMicrosoft Entraセキュリティグループである必要があります。 セキュリティが有効になっている、メールが有効になっていない、およびオンプレミス同期が有効になっていない非統合グループのみがサポートされます。

新しいグループの作成

次の表は、管理単位にグループを作成するときに指定する グループ リソースのプロパティを示しています。

プロパティ 型 説明
displayName string アドレス帳に表示するグループの名前。 必須です。
説明 string グループの説明 省略可能。
isAssignableToRole ブール値 グループを Microsoft Entra ロールに割り当てられるようにするには、true に設定します。 特権ロール管理者は、このプロパティの値を設定する最小特権ロールです。 省略可能。
mailEnabled ブール値 メールが有効なグループの場合は、true に設定します。 必須。
mailNickname string グループのメール エイリアス。 これらの文字は mailNickName: @()\[]";:.<>,SPACE では使用できません。 必須です。
securityEnabled ブール値 Microsoft 365 グループを含む、セキュリティが有効なグループに true を設定します。 必須です。
owners directoryObject コレクション このプロパティは、作成時のグループの所有者を表します。 省略可能。
members directoryObject コレクション このプロパティは、作成時のグループのメンバーを表します。 省略可能。
visibility String Microsoft 365 グループの表示を指定します。 有効な値は、 Private、 Public、 HiddenMembership、または空 ( Public と解釈されます) です。

応答

成功した場合、既存のオブジェクトを ( $ref を使用して) 追加すると、応答コード 204 No Content 返されます。 応答本文では何も返されません。

新しいグループを ( $refなしで) 作成する場合、このメソッドは応答本文で 201 Created 応答コードと グループ オブジェクトを返します。 応答には、そのグループの既定のプロパティのみが含まれます。 新しいメンバーをグループとして明示的に識別するには、要求本文で "@odata.type" : "#microsoft.graph.group" 行を指定する必要があります。 正しい @odata.type のない要求本文は、 400 Bad Request エラー メッセージを返します。

例

例 1:既存のユーザーまたはグループを追加する

次のようにすると、既存のユーザーまたはグループが管理単位に追加されます。

要求

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

POST https://graph.microsoft.com/beta/administrativeUnits/{id}/members/$ref
Content-type: application/json

{
  "@odata.id":"https://graph.microsoft.com/beta/groups/{id}"
}

要求本文で、追加するユーザー、グループ、またはデバイス オブジェクトのidを指定します。

応答

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

HTTP/1.1 204 No Content

例 2: 新しいグループを作成する

次の例では、管理単位に新しいグループを作成します。 新しいメンバーをグループとして明示的に識別するには、要求本文で "@odata.type" : "#microsoft.graph.group" 行を指定する必要があります。 正しい @odata.type のない要求本文は、 400 Bad Request エラー メッセージを返します。

要求

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

POST https://graph.microsoft.com/beta/administrativeUnits/{id}/members
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.group",
  "description": "Self help community for golf",
  "displayName": "Golf Assist",
  "groupTypes": [
    "Unified"
  ],
  "mailEnabled": true,
  "mailNickname": "golfassist",
  "securityEnabled": false
}

リクエストの本文で、追加する グループ オブジェクトのプロパティを指定します。

応答

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

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

HTTP/1.1 201 Created
Content-type: application/json

{
   "@odata.context": "https://graph.microsoft.com/beta/$metadata#groups/$entity",
     "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
     "deletedDateTime": null,
     "classification": null,
     "createdDateTime": "2018-12-22T02:21:05Z",
     "description": "Self help community for golf",
     "displayName": "Golf Assist",
     "expirationDateTime": null,
     "groupTypes": [
         "Unified"
     ],
   "isAssignableToRole": null,
     "mail": "golfassist@contoso.com",
     "mailEnabled": true,
     "mailNickname": "golfassist",
     "membershipRule": null,
     "membershipRuleProcessingState": null,
     "onPremisesLastSyncDateTime": null,
     "onPremisesSecurityIdentifier": null,
     "onPremisesSyncEnabled": null,
     "preferredDataLocation": "CAN",
     "preferredLanguage": null,
     "proxyAddresses": [
         "SMTP:golfassist@contoso.com"
     ],
     "renewedDateTime": "2018-12-22T02:21:05Z",
     "resourceBehaviorOptions": [],
     "resourceProvisioningOptions": [],
     "securityEnabled": false,
   "securityIdentifier": "S-1-12-1-1753967289-1089268234-832641959-555555555",
     "theme": null,
     "visibility": "Public",
     "onPremisesProvisioningErrors": []
}