メンバーを追加する

名前空間: microsoft.graph

メンバー のナビゲーション プロパティを使用して、セキュリティまたは Microsoft 365 グループにメンバーを追加します。

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

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

アクセス許可

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

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。
Application GroupMember.ReadWrite.All, Group.ReadWrite.All および Directory.ReadWrite.All

重要

役割割り当て可能なグループにメンバーを追加するには、呼び出し元のユーザーまたはアプリに RoleManagement.ReadWrite.Directory アクセス許可も割り当てる必要があります。

HTTP 要求

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

要求ヘッダー

ヘッダー
Authorization ベアラー {token}。必須。
Content-type application/json. Required.

要求本文

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

応答

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

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

要求

要求の例を次に示します。

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

関連項目