find_tenant_information_by_domain_name

Creates, updates, deletes, gets or lists a find_tenant_information_by_domain_name resource.

Overview

Name	find_tenant_information_by_domain_name
Type	Resource
Id	entra_id.tenant_relationships.find_tenant_information_by_domain_name

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
defaultDomainName	string	Primary domain name of a Microsoft Entra tenant.
displayName	string	Display name of a Microsoft Entra tenant.
federationBrandName	string	Name shown to users that sign in to a Microsoft Entra tenant.
tenantId	string	Unique identifier of a Microsoft Entra tenant.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain_name		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_name	string	Usage: domainName='{domainName}'

SELECT examples

get

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.

SELECT
defaultDomainName,
displayName,
federationBrandName,
tenantId
FROM entra_id.tenant_relationships.find_tenant_information_by_domain_name
WHERE domain_name = '{{ domain_name }}' -- required
;