Obter organização

Namespace: microsoft.graph

Obtenha as propriedades e relações da organização autenticada no momento.

Como o recurso da organização tem suporte para extensões, você também pode usar a operação GET para obter propriedades personalizadas e dados de extensão em uma instância de organização.

Essa API está disponível nas seguintes implantações de nuvem nacional.

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

Permissões

Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegada (conta corporativa ou de estudante) User.Read, Organization.Read.All, Directory.Read.All, Organization.ReadWrite.All, Directory.ReadWrite.All
Delegada (conta pessoal da Microsoft) Sem suporte.
Aplicativo Organization.Read.All, Directory.Read.All, Organization.ReadWrite.All, Directory.ReadWrite.All

Importante

Os aplicativos aos quais foi concedida a permissão User.Read poderão ler apenas as propriedades id, displayName e verifiedDomains da organização. Todas as outras propriedades retornam com null valores. Para ler todas as propriedades, use pelo menos Organization.Read.All.

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. Esta operação dá suporte às seguintes funções internas, que fornecem apenas o menor privilégio necessário:

  • Administrador de Licença AdHoc
  • Administrador de Aplicativos
  • Administrador de Autenticação
  • Administrador Azure Proteção de Informações
  • Administrador Azure Proteção de Informações
  • Administrador de Cobrança
  • Administrador de Aplicativos de Nuvem
  • Administrador de Dados de Conformidade
  • Aprovador de Acesso do Sistema de Proteção de Dados do Cliente
  • Aprovador de Acesso do Sistema de Proteção de Dados do Cliente
  • Análise de Área de Trabalho Administrador
  • Leitores de Diretório
  • Revisor de Diretório
  • Contas de sincronização de diretório - para serviços do Microsoft Entra Connect e do Microsoft Entra Cloud Sync
  • Escritores de diretório
  • Administrador do Dynamics 365
  • Administrador do Dynamics 365
  • Leitor Global
  • Usuário convidado
  • Administrador da Assistência Técnica
  • Administrador de Identidade Híbrida
  • Insights do Administrador
  • Administrador do Kaizala
  • Administrador de licenças
  • Administrador de caixa de correio
  • Administrador da Área de Trabalho Gerenciada da Microsoft
  • Usuário da Microsoft Store para Empresas
  • Administrador de Comércio Moderno
  • Administrador do Power BI
  • Administrador do Power BI
  • Administrador de Autenticação Privilegiada
  • Administrador de Função Privilegiada
  • Usuário convidado restrito
  • Administrador de Segurança
  • Operador de Segurança
  • Leitor de Segurança
  • Administrador do Suporte de Serviços
  • Administrador do Teams
  • Administrador de Comunicações do Teams
  • Engenheiro de Suporte de Comunicações de Equipes
  • Especialista em suporte à comunicação de equipes
  • Usuário
  • Administrador do usuário
  • Usuário do Centro de Empresas de Licenciamento por Volume
  • Usuário do Centro de Serviços de Licenciamento por Volume

Solicitação HTTP

GET /organization/{organizationId}

Parâmetros de consulta opcionais

Esse método dá suporte $select ao parâmetro de consulta OData para ajudar a personalizar a resposta.

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 bem sucedido, este método retorna um código de resposta 200 OK e uma coleção de um objeto de organização no corpo da resposta.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/organization/dcd219dd-bc68-4b9b-bf0b-4a33a796be35

Resposta

O exemplo a seguir mostra a 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#organization/$entity",
    "id": "84841066-274d-4ec0-a5c1-276be684bdd3",
    "deletedDateTime": null,
    "businessPhones": [
        "425-555-0100"
    ],
    "city": null,
    "country": null,
    "countryLetterCode": "NL",
    "createdDateTime": "2021-08-02T10:30:06Z",
    "defaultUsageLocation": "String",
    "displayName": "Contoso",
    "isMultipleDataLocationsForServicesEnabled": null,
    "marketingNotificationEmails": [],
    "onPremisesLastSyncDateTime": null,
    "onPremisesSyncEnabled": null,
    "partnerTenantType": "ResellerPartnerDelegatedAdmin",
    "postalCode": null,
    "preferredLanguage": "en",
    "securityComplianceNotificationMails": [],
    "securityComplianceNotificationPhones": [],
    "state": null,
    "street": null,
    "technicalNotificationMails": [
        "admin@contoso.com"
    ],
    "tenantType": "AAD",
    "directorySizeQuota": {
        "used": 698,
        "total": 50000
    },
    "assignedPlans": [
        {
            "assignedDateTime": "2022-04-03T02:46:42Z",
            "capabilityStatus": "Deleted",
            "service": "Adallom",
            "servicePlanId": "932ad362-64a8-4783-9106-97849a1a30b9"
        },
        {
            "assignedDateTime": "2022-04-03T02:46:42Z",
            "capabilityStatus": "Deleted",
            "service": "MultiFactorService",
            "servicePlanId": "8a256a2b-b617-496d-b51b-e76466e88db0"
        },
        {
            "assignedDateTime": "2021-08-02T10:36:57Z",
            "capabilityStatus": "Enabled",
            "service": "exchange",
            "servicePlanId": "113feb6c-3fe4-4440-bddc-54d774bf0318"
        },
        {
            "assignedDateTime": "2021-08-02T10:36:02Z",
            "capabilityStatus": "Deleted",
            "service": "SCO",
            "servicePlanId": "882e1d05-acd1-4ccb-8708-6ee03664b117"
        }
    ],
    "privacyProfile": {
        "contactEmail": "",
        "statementUrl": ""
    },
    "provisionedPlans": [
        {
            "capabilityStatus": "Deleted",
            "provisioningStatus": "Success",
            "service": "Adallom"
        },
        {
            "capabilityStatus": "Enabled",
            "provisioningStatus": "Success",
            "service": "exchange"
        }
    ],
    "verifiedDomains": [
        {
            "capabilities": "Email, OfficeCommunicationsOnline",
            "isDefault": true,
            "isInitial": true,
            "name": "Contoso.com",
            "type": "Managed"
        }
    ]
}