Skip to content

tenantrelationship-findtenantinformationbydomainname.md

Latest commit

 

History

History
107 lines (75 loc) · 3.63 KB

tenantrelationship-findtenantinformationbydomainname.md

File metadata and controls

107 lines (75 loc) · 3.63 KB
title tenantRelationship: findTenantInformationByDomainName
description Given a domain name, search for a tenant and read its tenantInformation.
author adimitui
ms.localizationpriority medium
ms.subservice entra-directory-management
doc_type apiPageType
ms.date 11/06/2024

tenantRelationship: findTenantInformationByDomainName

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Given a domain name, search for a tenant and read its tenantInformation. You can use this API to validate tenant information and use their tenantId to configure cross-tenant access settings between you and the tenant.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

Important

This API operation doesn't require the calling user to be assigned any Microsoft Entra role.

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

HTTP

GET https://graph.microsoft.com/beta/tenantRelationships/findTenantInformationByDomainName(domainName='contoso.com')

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

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/beta/$metadata#microsoft.graph.tenantInformation",
    "tenantId": "6babcaad-604b-40ac-a9d7-9fd97c0b779f",
    "federationBrandName": null,
    "displayName": "Contoso, Ltd",
    "defaultDomainName": "contoso.com"
}