tenantRelationship： findTenantInformationByDomainName
命名空间：microsoft.graph
给定域名后，搜索租户并读取其 tenantInformation。 可以使用此 API 来验证租户信息，并使用 tenantId在与租户之间配置跨租户访问设置。
此 API 可用于以下国家级云部署。
| 全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。
| 权限类型 | 最低特权权限 | 更高特权权限 |
|---|---|---|
| 委派（工作或学校帐户） | CrossTenantInformation.ReadBasic.All | 不可用。 |
| 委派（个人 Microsoft 帐户） | 不支持。 | 不支持。 |
| 应用程序 | CrossTenantInformation.ReadBasic.All | 不可用。 |
重要
此 API 操作不需要为调用用户分配任何Microsoft Entra角色。
HTTP 请求
GET /tenantRelationships/findTenantInformationByDomainName(domainName='{id}')
函数参数
在请求 URL 中，提供以下查询参数（含值）。 下表显示了必须用于此函数的参数。
| 参数 | 类型 | 说明 |
|---|---|---|
| domainName | String | Microsoft Entra租户的主域名。 |
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功，此方法在 200 OK 响应正文中返回响应代码和 tenantInformation 对象。
示例
请求
GET https://graph.microsoft.com/v1.0/tenantRelationships/findTenantInformationByDomainName(domainName='contoso.com')
响应
注意：为了提高可读性，可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.tenantInformation",
"tenantId": "6babcaad-604b-40ac-a9d7-9fd97c0b779f",
"federationBrandName": null,
"displayName": "Contoso, Ltd",
"defaultDomainName": "contoso.com"
}