tenantRelationship: findTenantInformationByDomainName

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Com um nome de domínio, procure um inquilino e leia o respetivo tenantInformation. Pode utilizar esta API para validar as informações do inquilino e utilizar o tenantId para configurar as definições de acesso entre inquilinos entre si e o inquilino.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global	US Government L4	US Government L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	✅

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	CrossTenantInformation.ReadBasic.All	Indisponível.
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	CrossTenantInformation.ReadBasic.All	Indisponível.

Importante

Esta operação de API não requer que seja atribuída qualquer função de Microsoft Entra ao utilizador de chamada.

Solicitação HTTP

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

Parâmetros de função

Na URL da solicitação, forneça os seguintes parâmetros de consulta com valores. A tabela seguinte mostra os parâmetros que têm de ser utilizados com esta função.

Parâmetro	Tipo	Descrição
domainName	Cadeia de caracteres	Nome de domínio principal de um inquilino Microsoft Entra.

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, este método devolve um 200 OK código de resposta e um objeto tenantInformation no corpo da resposta.

Exemplos

Solicitação

HTTP

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

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

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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