メンバーを追加する

[アーティクル]
02/14/2024

名前空間: microsoft.graph

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

次の表に、セキュリティグループまたは 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

重要

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

HTTP 要求

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

要求ヘッダー

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

要求本文

要求本文で、追加する 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}"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new ReferenceCreate
{
	OdataId = "https://graph.microsoft.com/v1.0/directoryObjects/{id}",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Groups["{group-id}"].Members.Ref.PostAsync(requestBody);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups members ref post --group-id {group-id} --body '{\
  "@odata.id": "https://graph.microsoft.com/v1.0/directoryObjects/{id}"\
}\
'



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewReferenceCreate()
odataId := "https://graph.microsoft.com/v1.0/directoryObjects/{id}"
requestBody.SetOdataId(&odataId) 

graphClient.Groups().ByGroupId("group-id").Members().Ref().Post(context.Background(), requestBody, nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.models.ReferenceCreate referenceCreate = new com.microsoft.graph.models.ReferenceCreate();
referenceCreate.setOdataId("https://graph.microsoft.com/v1.0/directoryObjects/{id}");
graphClient.groups().byGroupId("{group-id}").members().ref().post(referenceCreate);


const options = {
	authProvider,
};

const client = Client.init(options);

const directoryObject = {
  '@odata.id': 'https://graph.microsoft.com/v1.0/directoryObjects/{id}'
};

await client.api('/groups/{group-id}/members/$ref')
	.post(directoryObject);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\ReferenceCreate;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new ReferenceCreate();
$requestBody->setOdataId('https://graph.microsoft.com/v1.0/directoryObjects/{id}');

$graphServiceClient->groups()->byGroupId('group-id')->members()->ref()->post($requestBody)->wait();


Import-Module Microsoft.Graph.Groups

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

New-MgGroupMemberByRef -GroupId $groupId -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.models.reference_create import ReferenceCreate

graph_client = GraphServiceClient(credentials, scopes)

request_body = ReferenceCreate(
	odata_id = "https://graph.microsoft.com/v1.0/directoryObjects/{id}",
)

await graph_client.groups.by_group_id('group-id').members.ref.post(request_body)

要求本文で、追加する 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}"
    ]
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Group
{
	AdditionalData = new Dictionary<string, object>
	{
		{
			"members@odata.bind" , new List<string>
			{
				"https://graph.microsoft.com/v1.0/directoryObjects/{id}",
				"https://graph.microsoft.com/v1.0/directoryObjects/{id}",
				"https://graph.microsoft.com/v1.0/directoryObjects/{id}",
			}
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Groups["{group-id}"].PatchAsync(requestBody);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups patch --group-id {group-id} --body '{\
  "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}"\
    ]\
}\
'



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewGroup()
additionalData := map[string]interface{}{
	odataBind := []string {
		"https://graph.microsoft.com/v1.0/directoryObjects/{id}",
		"https://graph.microsoft.com/v1.0/directoryObjects/{id}",
		"https://graph.microsoft.com/v1.0/directoryObjects/{id}",
	}
}
requestBody.SetAdditionalData(additionalData)

groups, err := graphClient.Groups().ByGroupId("group-id").Patch(context.Background(), requestBody, nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Group group = new Group();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
LinkedList<String> membersOdataBind = new LinkedList<String>();
membersOdataBind.add("https://graph.microsoft.com/v1.0/directoryObjects/{id}");
membersOdataBind.add("https://graph.microsoft.com/v1.0/directoryObjects/{id}");
membersOdataBind.add("https://graph.microsoft.com/v1.0/directoryObjects/{id}");
additionalData.put("members@odata.bind", membersOdataBind);
group.setAdditionalData(additionalData);
Group result = graphClient.groups().byGroupId("{group-id}").patch(group);


const options = {
	authProvider,
};

const client = Client.init(options);

const group = {
  '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}'
    ]
};

await client.api('/groups/{group-id}')
	.update(group);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Group;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Group();
$additionalData = [
	'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}', ],
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->groups()->byGroupId('group-id')->patch($requestBody)->wait();


Import-Module Microsoft.Graph.Groups

$params = @{
	"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}"
)
}

Update-MgGroup -GroupId $groupId -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.models.group import Group

graph_client = GraphServiceClient(credentials, scopes)

request_body = Group(
	additional_data = {
			"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}",
			],
	}
)

result = await graph_client.groups.by_group_id('group-id').patch(request_body)

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

応答

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

HTTP/1.1 204 No Content

メンバーを追加する

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

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

要求

応答

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

要求

応答

フィードバック

フィードバック

その他のリソース

メンバーを追加する

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

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

要求

応答

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

要求

応答

関連コンテンツ

フィードバック

フィードバック

その他のリソース