获取 multiTenantOrganization

命名空间:microsoft.graph

获取多租户组织的属性。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) MultiTenantOrganization.ReadBasic.All MultiTenantOrganization.ReadWrite.All、MultiTenantOrganization.Read.All
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 MultiTenantOrganization.Read.All MultiTenantOrganization.ReadWrite.All

重要

在具有工作或学校帐户的委托方案中,必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 此操作支持以下最低特权角色。

  • 安全信息读取者
  • 全局读取者

登录用户无需分配安全读取者或全局读取者角色即可读取多租户组织和多租户组织成员租户的基本属性。

HTTP 请求

GET /tenantRelationships/multiTenantOrganization

可选的查询参数

此方法支持 $select OData 查询参数来帮助自定义响应。 若要了解一般信息,请参阅 OData 查询参数

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法在 200 OK 响应正文中返回响应代码和 multiTenantOrganization 对象。

示例

以下示例获取多租户组织的属性。

请求

GET https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization

响应

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/$entity",
    "id": "6d8b39e5-039a-4034-bf3a-e0b4f8cd60b6",
    "createdDateTime": "2023-05-26T22:05:23Z",
    "displayName": "Contoso organization",
    "description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank",
    "state": "active"
}

以下响应显示了请求租户不属于任何多租户组织的一部分。

HTTP/1.1 200 OK
Content-Type: application/json

{
    "createdDateTime": null,
    "displayName": null,
    "description": null,
    "state": "inactive"
}