tenantRelationship: findTenantInformationByDomainName
Namespace: microsoft.graph
Dado um nome de domínio, pesquise por um locatário e leia seu locatárioInformation. Você pode usar essa API para validar informações de locatário e usar o tenantId para configurar as configurações de acesso entre locatários entre você e o locatário.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
Tipo de permissão | Permissões menos privilegiadas | Permissões privilegiadas mais altas |
---|---|---|
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. |
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 a seguir mostra os parâmetros que devem ser usados com essa função.
Parâmetro | Tipo | Descrição |
---|---|---|
domainName | Cadeia de caracteres | Nome de domínio primário de um locatário 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, esse método retornará um 200 OK
código de resposta e um objeto tenantInformation no corpo da resposta.
Exemplos
Solicitação
GET https://graph.microsoft.com/v1.0/tenantRelationships/findTenantInformationByDomainName(domainName='contoso.com')
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/v1.0/$metadata#microsoft.graph.tenantInformation",
"tenantId": "6babcaad-604b-40ac-a9d7-9fd97c0b779f",
"federationBrandName": null,
"displayName": "Contoso, Ltd",
"defaultDomainName": "contoso.com"
}