Obter organização

Artigo
06/11/2024

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.

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

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

As aplicações concedidas à permissão User.Read só conseguem ler as propriedades id, displayName e verifiedDomains da organização. Todas as outras propriedades são devolvidas com null valores. Para ler todas as propriedades, utilize, pelo menos, Organization.Read.All.

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.

Administrador de Licenças do AdHoc
Administrador de Aplicativos
Administrador de Autenticação
Administrador Proteção de Informações do Azure
Administrador Proteção de Informações do Azure
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
Administrador do Análise de Área de Trabalho
Leitores de Diretórios
Revisor de Diretórios
Contas de Sincronização de Diretórios – para serviços Microsoft Entra Connect e Microsoft Entra Cloud Sync
Escritores de diretório
Administrador do Dynamics 365
Administrador do Dynamics 365
Leitor Global
Utilizador 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 de Ambiente de Trabalho Gerido da Microsoft
Utilizador 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
Utilizador 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
Utilizador do Centro de Empresas de Licenciamento em Volume
Utilizador do Centro de Serviços de Licenciamento em Volume

Solicitação HTTP

HTTP

GET /organization/{organizationId}

Parâmetros de consulta opcionais

Este método suporta o $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.

msgraph

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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Organization["{organization-id}"].GetAsync();

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

Bash



mgc organization get --organization-id {organization-id}

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



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
organization, err := graphClient.Organization().ByOrganizationId("organization-id").Get(context.Background(), nil)

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

Java


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Organization result = graphClient.organization().byOrganizationId("{organization-id}").get();

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

JavaScript


const options = {
	authProvider,
};

const client = Client.init(options);

let organization = await client.api('/organization/dcd219dd-bc68-4b9b-bf0b-4a33a796be35')
	.get();

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

PHP


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->organization()->byOrganizationId('organization-id')->get()->wait();

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

PowerShell


Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgOrganization -OrganizationId $organizationId

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

Python


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.organization.by_organization_id('organization-id').get()

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

Resposta

O exemplo a seguir mostra a resposta. Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP

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

Partilhar via

Obter organização

Permissões

Solicitação HTTP

Parâmetros de consulta opcionais

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplo

Solicitação

Resposta

Comentários

Recursos adicionais