Partilhar via


Criar connectedOrganization

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.

Crie um novo objeto connectedOrganization .

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) EntitlementManagement.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application EntitlementManagement.ReadWrite.All Indisponível.

Dica

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada também tem de ter uma função de administrador com permissões de função suportadas através da seguinte opção:

  • Uma função Microsoft Entra em que a função com menos privilégios é Administrador de Governação de Identidades. Esta é a opção com menos privilégios.

Em cenários apenas de aplicações, a aplicação de chamadas pode ser atribuída a uma das funções suportadas anteriores em vez da permissão da aplicação EntitlementManagement.ReadWrite.All . A função Administrador de Governação de Identidade é menos privilegiada do que a permissão da aplicação EntitlementManagement.ReadWrite.All .

Para obter mais informações, veja Delegação e funções na gestão de direitos e como delegar a governação de acesso aos gestores de pacotes de acesso na gestão de direitos.

Solicitação HTTP

POST /identityGovernance/entitlementManagement/connectedOrganizations

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo do pedido, forneça uma representação JSON do objeto connectedOrganization .

A tabela seguinte lista as propriedades necessárias quando cria a connectedOrganization.

Propriedade Tipo Descrição
displayName Cadeia de caracteres O nome da organização ligada.
description Cadeia de caracteres A descrição da organização ligada.
identitySources identitySource collection Uma coleção com um elemento, a origem de identidade inicial nesta organização ligada.
state connectedOrganizationState O estado de uma organização ligada define se as políticas de atribuição com o tipo AllConfiguredConnectedOrganizationSubjects de âmbito do requerente são aplicáveis ou não. Os valores possíveis são: configured e proposed.

O membro único da coleção identitySources deve ser do tipo domainIdentitySource ou externalDomainFederation . Se o autor da chamada fornecer um domainIdentitySource, a chamada é efetuada com êxito e o domínio corresponde a um domínio registado de um inquilino Microsoft Entra, então a connectedOrganization resultante criada terá uma coleção identitySources que contém um único membro do tipo azureActiveDirectoryTenant.

Resposta

Se for bem-sucedido, este método devolve um 201 Created código de resposta e um novo objeto connectedOrganization no corpo da resposta.

Exemplos

Exemplo 1: Criar uma organização ligada

Solicitação

POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/connectedOrganizations/
Content-Type: application/json

{
  "displayName":"Connected organization name",
  "description":"Connected organization description",
  "identitySources": [
    {
      "@odata.type": "#microsoft.graph.domainIdentitySource",
      "domainName": "example.com",
      "displayName": "example.com"
      }
  ],
  "state":"proposed"
}

Resposta

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

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "006111db-0810-4494-a6df-904d368bd81b",
  "displayName":"Connected organization name",
  "description":"Connected organization description",
  "createdBy": "admin@contoso.com",
  "createdDateTime": "2020-06-08T20:13:53.7099947Z",
  "modifiedBy": "admin@contoso.com",
  "modifiedDateTime": "2020-06-08T20:13:53.7099947Z",
  "state":"proposed"
}

Exemplo 2: Criar uma organização ligada com uma identidadeOrigem com base num ID de inquilino

Este exemplo mostra a criação de uma organização ligada com uma origem de identidade com base num ID de inquilino. O ID de inquilino pode ser encontrado, pelo nome de domínio, com a chamada tenantRelationship: findTenantInformationByDomainName .

Solicitação

POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/connectedOrganizations/
Content-Type: application/json

{
  "displayName":"Connected organization name",
  "description":"Connected organization description",
  "identitySources": [
    {
      "@odata.type": "#microsoft.graph.azureActiveDirectoryTenant",
      "displayName": "Contoso",
      "tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee"
      }
  ],
  "state":"proposed"
}

Resposta

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

HTTP/1.1 201 Created
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/entitlementManagement/connectedOrganizations/$entity",
  "id": "922c86cf-65b8-4d94-b6a6-477dde331c7b",
  "displayName": "Connected organization name",
  "description": "Connected organization description",
  "createdDateTime": "2024-10-29T21:55:39.6051923Z",
  "modifiedDateTime": "2024-10-29T21:55:39.6051923Z",
  "state": "proposed",
  "identitySources": []
}