Todos os produtos
Search
Central de documentação

Identity as a Service:GetOrganizationalUnitIdByExternalId

Última atualização: Jun 28, 2026

Obtém o ID de uma unidade organizacional com base no ID externo.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

POST /v2/{instanceId}/{applicationId}/organizationalUnits/_/actions/getOrganizationalUnitIdByExternalId HTTP/1.1

Parâmetros de caminho

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

instanceId

string

Sim

O ID da instância.

idaas_ue2jvisn35ea5lmthk267xxxxx

applicationId

string

Sim

O ID da aplicação.

app_mkv7rgt4d7i4u7zqtzev2mxxxx

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Authorization

string

Sim

As informações de autenticação. Formato: Bearer ${access_token}. Exemplo: Bearer ATxxxx.

Bearer AT8csE2seYxxxxxij

body

object

Não

O corpo da solicitação.

xxx001

organizationalUnitExternalId

string

Sim

O ID externo da unidade organizacional. O ID externo pode ser usado para mapear dados externos para os dados da unidade organizacional no Employee Identity and Access Management (EIAM) do Identity as a Service (IDaaS). Por padrão, o ID externo é o ID da unidade organizacional.

Nota: Para unidades organizacionais com o mesmo tipo de origem e ID de origem, cada unidade organizacional possui um ID externo exclusivo.

ou_wovwffm62xifdziem7an7xxxxx

organizationalUnitSourceType

string

Sim

O tipo de origem da unidade organizacional. Valores válidos:

  • build_in: A unidade organizacional foi criada no IDaaS.

  • ding_talk: A unidade organizacional foi importada do DingTalk.

  • ad: A unidade organizacional foi importada do Microsoft Active Directory (AD).

  • ldap: A unidade organizacional foi importada de um serviço Lightweight Directory Access Protocol (LDAP).

build_in

organizationalUnitSourceId

string

Sim

O ID de origem da unidade organizacional.

Se a unidade organizacional foi criada no IDaaS, seu ID de origem é o ID da instância do IDaaS. Se a unidade organizacional foi importada, seu ID de origem é o ID da empresa na origem. Por exemplo, se a unidade organizacional foi importada do DingTalk, seu ID de origem é o valor corpId da empresa no DingTalk.

idaas_ue2jvisn35ea5lmthk267xxxxx

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

OrganizationalUnitIdObject.

organizationalUnitId

string

O ID da unidade organizacional.

ou_wovwffm62xifdziem7an7xxxxx

Exemplos

Resposta de sucesso

JSON formato

{
  "organizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.