tenantRelationship: findTenantInformationByDomainName

Espacio de nombres: microsoft.graph

Dado un nombre de dominio, busque un inquilino y lea su tenantInformation. Puede usar esta API para validar la información del inquilino y usar tenantId para configurar los valores de acceso entre inquilinos entre usted y el inquilino.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	CrossTenantInformation.ReadBasic.All	No disponible.
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	CrossTenantInformation.ReadBasic.All	No disponible.

Importante

Esta operación de API no requiere que al usuario que realiza la llamada se le asigne ningún rol de Microsoft Entra.

Solicitud HTTP

GET /tenantRelationships/findTenantInformationByDomainName(domainName='{id}')

Parámetros de función

En la dirección URL de la solicitud, proporcione los siguientes parámetros de consulta con valores. En la tabla siguiente se muestran los parámetros que se deben usar con esta función.

Parámetro	Tipo	Descripción
domainName	Cadena	Nombre de dominio principal de un inquilino de Microsoft Entra.

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y un objeto tenantInformation en el cuerpo de la respuesta.

Ejemplos

Solicitud

HTTP

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let tenantInformation = await client.api('/tenantRelationships/findTenantInformationByDomainName(domainName='contoso.com')')
	.get();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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"
}