次の方法で共有


メンバーを追加する

名前空間: microsoft.graph

セキュリティまたは Microsoft 365 グループにメンバーを追加します。 API を使用して 1 つの要求に複数のメンバーを追加する場合は、最大 20 人のメンバーのみを追加できます。

次の表に、セキュリティ グループまたは Microsoft 365 グループのいずれかに追加できるメンバーの種類を示します。

オブジェクトの種類 セキュリティ グループのメンバー Microsoft 365 グループのメンバー
User グループ メンバーにできます グループ メンバーにできます
セキュリティ グループ グループ メンバーにできます グループ メンバーにできません
Microsoft 365 グループ グループ メンバーにできません グループ メンバーにできません
デバイス グループ メンバーにできます グループ メンバーにできません
サービス プリンシパル グループ メンバーにできます グループ メンバーにできません
組織の連絡先 グループ メンバーにできます グループ メンバーにできません

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

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

アクセス許可

次の表は、この API を呼び出すときに各リソースの種類に必要な最小特権のアクセス許可を示しています。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

サポートされているリソース 委任 (職場または学校のアカウント) 委任 (個人用 Microsoft アカウント) アプリケーション
device GroupMember.ReadWrite.All と Device.ReadWrite.All サポートされていません。 GroupMember.ReadWrite.All と Device.ReadWrite.All
group GroupMember.ReadWrite.All サポートされていません。 GroupMember.ReadWrite.All
orgContact GroupMember.ReadWrite.All と OrgContact.Read.All サポートされていません。 GroupMember.ReadWrite.All と OrgContact.Read.All
servicePrincipal GroupMember.ReadWrite.All と Application.ReadWrite.All サポートされていません。 GroupMember.ReadWrite.All と Application.ReadWrite.All
user GroupMember.ReadWrite.All サポートされていません。 GroupMember.ReadWrite.All

委任されたシナリオでは、サインインしているユーザーに、サポートされている Microsoft Entra ロール または microsoft.directory/groups/members/update ロールのアクセス許可を持つカスタム ロールも割り当てる必要があります。 この操作では、ロール割り当て可能なグループを除き、次の最小特権ロールがサポートされます。

  • グループ所有者
  • ディレクトリ製作者
  • グループ管理者
  • ID ガバナンス管理者
  • ユーザー管理者
  • Exchange 管理者 - Microsoft 365 グループの場合のみ
  • SharePoint 管理者 - Microsoft 365 グループの場合のみ
  • Teams 管理者 - Microsoft 365 グループの場合のみ
  • Yammer 管理者 - Microsoft 365 グループの場合のみ
  • Intune 管理者 - セキュリティ グループの場合のみ

ロール割り当て可能なグループにメンバーを追加するには、アプリにも RoleManagement.ReadWrite.Directory アクセス許可が割り当てられ、呼び出し元のユーザーにサポートされている Microsoft Entra ロールが割り当てられている必要があります。 特権ロール管理者 は、この操作でサポートされる最小限の特権ロールです。

HTTP 要求

POST /groups/{group-id}/members/$ref
POST /groups/{group-id}/members/

要求ヘッダー

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

要求本文

/groups/{group-id}/members/$ref構文を使用する場合は、@odata.id プロパティを含む JSON オブジェクトを指定し、サポートされているグループ メンバー オブジェクト型への ID による参照を指定します。

/groups/{group-id}/members構文を使用する場合は、サポートされているグループ メンバー オブジェクト型への ID による 1 つ以上の参照を含むmembers@odata.bind プロパティを含む JSON オブジェクトを指定します。

directoryObjects 参照 (つまり、https://graph.microsoft.com/v1.0/directoryObjects/{id}) を使用する場合、オブジェクト型は引き続きサポートされているグループ メンバー オブジェクト型である必要があります。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。 オブジェクトが既にグループのメンバーであるか、グループ メンバーとしてサポートされていない場合は、 400 Bad Request 応答コードを返します。 追加するオブジェクトが存在しない場合は、 404 Not Found 応答コードが返されます。

例 1: グループにメンバーを追加する

要求

次の例は、 directoryObjects 参照を使用してグループにメンバーを追加する要求を示しています。

POST https://graph.microsoft.com/v1.0/groups/{group-id}/members/$ref
Content-type: application/json

{
  "@odata.id": "https://graph.microsoft.com/v1.0/directoryObjects/{id}"
}

要求本文で、追加する directoryObject、ユーザー または グループ オブジェクトの ID の JSON 表記を指定します。

応答

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

HTTP/1.1 204 No Content

例 2: 1 つの要求でグループに複数のメンバーを追加する

この例は、PATCH 操作で OData バインドがサポートされているグループに複数のメンバーを追加する方法を示しています。 1 つの要求に最大 20 人のメンバーを追加できます。 POST 操作はサポートされていません。 要求の本文にエラー条件が存在する場合、メンバーは追加されず、適切な応答コードが返されます。

要求

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

PATCH https://graph.microsoft.com/v1.0/groups/{group-id}
Content-type: application/json

{
  "members@odata.bind": [
    "https://graph.microsoft.com/v1.0/directoryObjects/{id}",
    "https://graph.microsoft.com/v1.0/directoryObjects/{id}",
    "https://graph.microsoft.com/v1.0/directoryObjects/{id}"
    ]
}

要求本文で、追加する directoryObject、ユーザー または グループ オブジェクトの ID の JSON 表記を指定します。

応答

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

HTTP/1.1 204 No Content