Todos os produtos
Search

Este produto

    Identity as a Service:GetUserIdByUserExternalId

    Central de documentação

    Identity as a Service:GetUserIdByUserExternalId

    Última atualização: Jun 28, 2026

    Consulta o ID de uma conta do Employee Identity and Access Management (EIAM) 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}/users/_/actions/getUserIdByExternalId 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.

    userExternalId

    string

    Sim

    O ID externo da conta.

    xxx001
    userSourceType

    string

    Sim

    O tipo de origem da conta. Valores válidos:

    • build_in: A conta foi criada no Identity as a Service (IDaaS).

    • ding_talk: A conta foi importada do DingTalk.

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

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

    build_in
    userSourceId

    string

    Sim

    O ID de origem da conta. Se a conta foi criada no IDaaS, seu ID de origem é o ID da instância do IDaaS. Se a conta foi importada, seu ID de origem é o ID da empresa na origem. Por exemplo, se a conta 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

    Os parâmetros de resposta.

    userId

    string

    O ID da conta.

    user_d6sbsuumeta4h66ec3il7yxxxx

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "userId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}

    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.