メンバーを追加する

[アーティクル]
10/25/2024

名前空間: microsoft.graph

この API を使用して、メンバー (ユーザー、グループ、またはデバイス) を管理単位に追加します。現時点では、一度に 1 つのメンバーを管理単位に追加することしかできません。

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

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

アクセス許可

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

既存のユーザー、グループ、またはデバイスを追加するためのアクセス許可

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

重要

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

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

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

重要

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

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

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

HTTP 要求

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

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

次の要求により、管理単位内に新しいグループが作成されます。

POST /directory/administrativeUnits/{id}/members

要求ヘッダー

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

要求本文

既存のユーザー、グループ、またはデバイスの追加

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

新しいグループの作成

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

プロパティ	型	説明
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/v1.0/directory/administrativeUnits/{id}/members/$ref
Content-type: application/json

{
  "@odata.id":"https://graph.microsoft.com/v1.0/groups/{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/groups/{id}",
};

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



mgc directory administrative-units members ref post --administrative-unit-id {administrativeUnit-id} --body '{\
  "@odata.id":"https://graph.microsoft.com/v1.0/groups/{id}"\
}\
'



// Code snippets are only available for the latest major version. Current major version is $v1.*

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

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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Directory().AdministrativeUnits().ByAdministrativeUnitId("administrativeUnit-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/groups/{id}");
graphClient.directory().administrativeUnits().byAdministrativeUnitId("{administrativeUnit-id}").members().ref().post(referenceCreate);


const options = {
	authProvider,
};

const client = Client.init(options);

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

await client.api('/directory/administrativeUnits/{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/groups/{id}');

$graphServiceClient->directory()->administrativeUnits()->byAdministrativeUnitId('administrativeUnit-id')->members()->ref()->post($requestBody)->wait();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

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

New-MgDirectoryAdministrativeUnitMemberByRef -AdministrativeUnitId $administrativeUnitId -BodyParameter $params


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.reference_create import ReferenceCreate
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ReferenceCreate(
	odata_id = "https://graph.microsoft.com/v1.0/groups/{id}",
)

await graph_client.directory.administrative_units.by_administrative_unit_id('administrativeUnit-id').members.ref.post(request_body)

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

応答

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

HTTP/1.1 204 No Content

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

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

要求