命名空间:microsoft.graph
将租户添加到多租户组织。 所有者租户的管理员有权将租户添加到多租户组织。 添加的租户处于挂起状态,直到添加的租户的管理员通过提交加入请求加入多租户组织。 租户只能是一个多租户组织的一部分。
此 API 可用于以下国家级云部署。
全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
✅ |
❌ |
❌ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 |
最低特权权限 |
更高特权权限 |
委派(工作或学校帐户) |
MultiTenantOrganization.ReadWrite.All |
不可用。 |
委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
应用程序 |
MultiTenantOrganization.ReadWrite.All |
不可用。 |
重要
在具有工作或学校帐户的委托方案中,必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。
安全管理员 是此操作支持的最低特权角色。
HTTP 请求
POST /tenantRelationships/multiTenantOrganization/tenants
名称 |
说明 |
Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Content-Type |
application/json. 必需。 |
请求正文
在请求正文中,提供 multiTenantOrganizationMember 对象的 JSON 表示形式。
创建 multiTenantOrganizationMember 时,可以指定以下属性。
属性 |
类型 |
说明 |
tenantId |
String |
要添加到多租户组织的Microsoft Entra租户的租户 ID。 必填。 |
displayName |
String |
添加到多租户组织的租户的显示名称。 目前,设置后无法更改。 必填。 |
role |
multiTenantOrganizationMemberRole |
租户在多租户组织中的角色。 可能的值为: owner 、 member (默认) 、 unknownFutureValue 。 可选。 |
响应
如果成功,此方法在 201 Created
响应正文中返回响应代码和 multiTenantOrganizationMember 对象。 如果租户在此多租户组织中已挂起或处于活动状态,则会收到“Request_BadRequest”错误。
示例
以下示例将 Fabrikam 租户添加到多租户组织。
请求
POST https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/tenants
Content-Type: application/json
{
"tenantId": "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad",
"displayName": "Fabrikam"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new MultiTenantOrganizationMember
{
TenantId = "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad",
DisplayName = "Fabrikam",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.TenantRelationships.MultiTenantOrganization.Tenants.PostAsync(requestBody);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
mgc tenant-relationships multi-tenant-organization tenants create --body '{\
"tenantId": "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad",\
"displayName": "Fabrikam"\
}\
'
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// 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.NewMultiTenantOrganizationMember()
tenantId := "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad"
requestBody.SetTenantId(&tenantId)
displayName := "Fabrikam"
requestBody.SetDisplayName(&displayName)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
tenants, err := graphClient.TenantRelationships().MultiTenantOrganization().Tenants().Post(context.Background(), requestBody, nil)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
MultiTenantOrganizationMember multiTenantOrganizationMember = new MultiTenantOrganizationMember();
multiTenantOrganizationMember.setTenantId("4a12efe6-aa14-4d03-8dff-88fc89e2e2ad");
multiTenantOrganizationMember.setDisplayName("Fabrikam");
MultiTenantOrganizationMember result = graphClient.tenantRelationships().multiTenantOrganization().tenants().post(multiTenantOrganizationMember);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
const multiTenantOrganizationMember = {
tenantId: '4a12efe6-aa14-4d03-8dff-88fc89e2e2ad',
displayName: 'Fabrikam'
};
await client.api('/tenantRelationships/multiTenantOrganization/tenants')
.post(multiTenantOrganizationMember);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\MultiTenantOrganizationMember;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new MultiTenantOrganizationMember();
$requestBody->setTenantId('4a12efe6-aa14-4d03-8dff-88fc89e2e2ad');
$requestBody->setDisplayName('Fabrikam');
$result = $graphServiceClient->tenantRelationships()->multiTenantOrganization()->tenants()->post($requestBody)->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
Import-Module Microsoft.Graph.Identity.SignIns
$params = @{
tenantId = "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad"
displayName = "Fabrikam"
}
New-MgTenantRelationshipMultiTenantOrganizationTenant -BodyParameter $params
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.multi_tenant_organization_member import MultiTenantOrganizationMember
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = MultiTenantOrganizationMember(
tenant_id = "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad",
display_name = "Fabrikam",
)
result = await graph_client.tenant_relationships.multi_tenant_organization.tenants.post(request_body)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/tenants/$entity",
"tenantId": "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad",
"displayName": "Fabrikam",
"addedDateTime": "2023-05-27T19:24:29Z",
"joinedDateTime": null,
"addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
"role": "member",
"state": "pending",
"transitionDetails": null
}
如果租户在此多租户组织中已挂起或处于活动状态,则会收到“Request_BadRequest”错误。
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"error": {
"code": "Request_BadRequest",
"message": "Tenant is already being added in Multi-Tenant Organization.",
"innerError": {
"date": "2023-05-27T20:56:14",
"request-id": "a1e5973c-66f1-4853-9e3d-39e6b4f606d1",
"client-request-id": "651548c3-e864-4509-837b-4f5d4cf546a5"
}
}
}