tenantRelationship: findTenantInformationByDomainName
Namespace: microsoft.graph
Given a domain name, search for a tenant and read its tenantInformation. You can use this API to validate tenant information and use the tenantId to configure cross-tenant access settings between you and the tenant.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | CrossTenantInformation.ReadBasic.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | CrossTenantInformation.ReadBasic.All | Not available. |
HTTP request
GET /tenantRelationships/findTenantInformationByDomainName(domainName='{id}')
Function parameters
In the request URL, provide the following query parameters with values. The following table shows the parameters that must be used with this function.
Parameter | Type | Description |
---|---|---|
domainName | String | Primary domain name of a Microsoft Entra tenant. |
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a tenantInformation object in the response body.
Examples
Request
GET https://graph.microsoft.com/v1.0/tenantRelationships/findTenantInformationByDomainName(domainName='contoso.com')
Response
Note: The response object shown here might be shortened for readability.
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"
}