Obter organização

  • Artigo

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 nacionais de nuvem.

Serviço global Governo dos EUA L4 GOVERNO DOS EUA 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

Para cenários delegados, o usuário conectado deve ter pelo menos uma das seguintes funções de Microsoft Entra.

  • Administrador de licença do AdHoc
  • Administrador de Aplicativos
  • Administrador de Autenticação
  • Administrador do Azure Proteção de Informações
  • Administrador do Azure Proteção de Informações
  • Administrador de Cobrança
  • Administrador de Aplicativos de Nuvem
  • Administrador de Dados de Conformidade
  • Aprovador de acesso do Customer LockBox
  • Aprovador de acesso do Customer LockBox
  • Administrador Análise de Área de Trabalho
  • Leitores de Diretório
  • Revisor de Diretório
  • Escritores de diretório
  • Administrador do Dynamics 365
  • Administrador do Dynamics 365
  • Leitor Global
  • Usuário Convidado
  • Administrador da Assistência Técnica
  • Insights do Administrador
  • Administrador kaizala
  • Administrador de Licenças
  • Administrador de caixa de correio
  • Administrador da Área de Trabalho Gerenciada da Microsoft
  • Microsoft Store para Empresas Usuário
  • Administrador do 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 Business Center de Licenciamento de Volume
  • Usuário do Centro de Serviço de Licenciamento de Volume

Os aplicativos que receberam a permissão User.Read podem 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.

Solicitação HTTP

GET /organization/{organizationId}

Parâmetros de consulta opcionais

Esse método dá suporte ao $selectparâ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"
        }
    ]
}