命名空间:microsoft.graph
获取多租户组织中的租户及其属性。
此 API 可用于以下国家级云部署。
全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
✅ |
❌ |
❌ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 |
最低特权权限 |
更高特权权限 |
委派(工作或学校帐户) |
MultiTenantOrganization.ReadWrite.All |
不可用。 |
委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
应用程序 |
MultiTenantOrganization.ReadWrite.All |
不可用。 |
如果使用 MultiTenantOrganization.ReadBasic.All 权限调用,则调用方只能读取 displayName 和 tenantId 属性。
重要
在具有工作或学校帐户的委托方案中,必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 此操作支持以下最低特权角色。
登录用户无需分配安全读取者或全局读取者角色即可读取多租户组织和多租户组织成员租户的基本属性。
HTTP 请求
GET /tenantRelationships/multiTenantOrganization/tenants/{tenantId}
可选的查询参数
此方法支持 $select
OData 查询参数来帮助自定义响应。 若要了解一般信息,请参阅 OData 查询参数。
名称 |
说明 |
Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在 200 OK
响应正文中返回响应代码和 multiTenantOrganizationMember 对象。
示例
以下示例获取多租户组织中的租户及其属性。
请求
GET https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/tenants/1fd6544e-e994-4de2-9f1b-787b51c7d325
// Code snippets are only available for the latest version. Current version is 5.x
// 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["{multiTenantOrganizationMember-id}"].GetAsync();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
mgc tenant-relationships multi-tenant-organization tenants get --multi-tenant-organization-member-id {multiTenantOrganizationMember-id}
有关如何将 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"
//other-imports
)
// 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().ByMultiTenantOrganizationMemberId("multiTenantOrganizationMember-id").Get(context.Background(), nil)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
MultiTenantOrganizationMember result = graphClient.tenantRelationships().multiTenantOrganization().tenants().byMultiTenantOrganizationMemberId("{multiTenantOrganizationMember-id}").get();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
let multiTenantOrganizationMember = await client.api('/tenantRelationships/multiTenantOrganization/tenants/1fd6544e-e994-4de2-9f1b-787b51c7d325')
.get();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->tenantRelationships()->multiTenantOrganization()->tenants()->byMultiTenantOrganizationMemberId('multiTenantOrganizationMember-id')->get()->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
Import-Module Microsoft.Graph.Identity.SignIns
Get-MgTenantRelationshipMultiTenantOrganizationTenant -MultiTenantOrganizationMemberId $multiTenantOrganizationMemberId
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.tenant_relationships.multi_tenant_organization.tenants.by_multi_tenant_organization_member_id('multiTenantOrganizationMember-id').get()
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
响应
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/tenants/$entity",
"tenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
"displayName": "Contoso",
"addedDateTime": "2023-05-26T22:05:23Z",
"joinedDateTime": null,
"addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
"role": "owner",
"state": "active",
"transitionDetails": null
}
如果正在进行更新, transitionDetails
则列出有关更新的信息。 以下响应指示角色正在从成员更改为所有者。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/tenants/$entity",
"tenantId": "5036a0a0-a7a4-4933-9086-5dd54535dd6e",
"displayName": "Woodgrove Bank",
"addedDateTime": "2023-05-27T21:52:40Z",
"joinedDateTime": null,
"addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
"role": "member",
"state": "pending",
"transitionDetails": {
"desiredState": "active",
"desiredRole": "owner",
"status": "notStarted",
"details": null
}
}