Como configurar uma conexão para enviar uma solicitação do OAuth por meio do MID Server usando o cofre externo

  • Versão de lançamento: Xanadu
  • Atualizado 9 de jan. de 2026
  • 10 min. de leitura

    • Configure uma conexão para enviar solicitações de tokens OAuth 2.0 a um servidor de autenticação de terceiros por meio do MID Server. O MID Server adiciona credenciais do OAuth 2.0 (ID e segredo do cliente) à solicitação a partir do cofre externo CyberArk, do escopo do OAuth e da URL do token da instância e os envia ao servidor de autenticação de terceiros.

    Antes de Iniciar

    Verifique os itens abaixo.

    Função necessária: nenhuma

    Por Que e Quando Desempenhar Esta Tarefa

    É possível configurar a conexão e a credencial com um modelo de configuração ou manualmente. Um modelo de configuração define os componentes do formulário de registro da conexão e é reutilizável para outros registros de conexão. Manualmente, somente é possível configurar a conexão para um só registro. O tópico mostra as duas abordagens.

    Procedimento

    1. Configure a conexão com um modelo de configuração.
      1. Navegar até Todos > IntegrationHub > Modelos de Configuração.
      2. Selecione Novo.
      3. Selecione Conexão HTTP com tipo de concessão de Credenciais de cliente OAuth (armazenamento externo).
      4. Atualize o formulário conforme necessário.
        Por exemplo, é possível informar o escopo nos campos oauth_entity_profile_scope e oauth_entity_scope da seção "Modelo de dados padrão". Para aprender a criar um modelo de configuração, consulte Crie um modelo de configuração.
      5. Selecione Enviar.
        Você criou o modelo de configuração.
      6. Navegar até Todos > IntegrationHub > Aliases de conexão e credencial.
      7. Atualize o formulário.
        Tabela 1. Alias de conexão e credencial
        Campo Descrição
        Nome Nome do alias. Um alias só pode conter caracteres alfa, número e sublinhado.

        Durante um upgrade, o marcador no registro de credencial migra para um alias de credencial e conexão. Se o marcador de credencial contiver caracteres especiais diferentes de alfabetos, números e sublinhados, isso preserva o nome do marcador após um upgrade. Ainda é possível usar esse alias migrado, mas não é possível atualizá-lo até que você mude o nome para atender às restrições de nomenclatura.
        Aplicação Identificador exclusivo do alias de conexão e credencial, com base no formato scope_name.alias_name.
        • Se o escopo for Global, o ID será o nome do alias. Por exemplo, se você criar um alias do Workday no escopo global, ele definirá o ID para workday.
        • Se você criar um alias do workday no escopo do app de RH, ele definirá o ID como x_hr_app.workday.
        Alias primário Opção para selecionar o alias sob o qual você está criando esse alias de conexão e credencial. O alias de conexão e credencial que você está criando é um alias secundário. Um alias secundário é listado na guia Aliases secundários, na página do alias primário de conexão e credencial.

        Alias secundário na guia "Aliases secundários".
        Tipo Opção para indicar o tipo de alias que você está criando. Escolha dentre as seguintes opções.
        • Credencial: alias que contém um registro de credencial.
        • Conexão e credencial: alias que contém um registro de conexão e credencial. Essa opção é selecionada por padrão.

        Confirme se a opção "Conexão e credencial" está selecionada.
        Suporte a várias conexões ativas Designador que indica se o alias suporta várias conexões ativas. Adicione conexões usando a tabela Conexões e as associe ao alias usando a lista relacionada às Conexões.
        Política de nova tentativa padrão Tente novamente a política para o alias. Para obter mais informações, consulte Política de nova tentativa.
        Modelo de configuração Opção para selecionar o modelo de configuração com base no qual você está criando o alias de conexão e credencial. Selecione o modelo do tipo Conexão HTTP com tipo de concessão de Credenciais de cliente OAuth (armazenamento externo) que você criou.
      8. Selecione Enviar.
        Você criou o registro de alias de conexão e credencial.
      9. Navegar até Todos > IntegrationHub > Painel de Conexões.
      10. No campo "Pesquisar todas as conexões", digite o nome do registro de alias de conexão e credencial que você criou.
      11. No registro, selecione Exibir detalhes.
      12. Selecione Configurar.
      13. Preencha o formulário
        Tabela 2. Formulário "Configurar conexão"
        Campo Descrição
        Nome da conexão O nome da conexão. Não é possível atualizar o nome.
        URL de conexão URL para o servidor de terceiros.
        Usar MID Opção para habilitar o MID Server.
        Importante:
        Confirme se a opção está selecionada.
        Seleção de MID Opção para especificar a configuração do MID para conexão.
        • MID Server específico: opção para indicar a seleção manual de um MID Server específico.
        • Selecionar automaticamente o MID Server: opção para indicar que você deseja que o MID Server seja selecionado automaticamente.
        • Cluster do MID específico: opção para indicar a seleção manual de um cluster de MID Servers.
        Importante:
        Confirme se o MID Server que você selecionou reside na mesma máquina que o Cliente CyberArk AIM que está configurado para acessar o cofre CyberArk. Consulte Configure o cofre da CyberArk e instale a API AIM.
        MID Server Opção para especificar um MID Server manualmente. Essa opção aparecerá se você selecionar MID Server específico no campo Seleção de MID.
        Cluster do MID Opção para especificar um cluster do MID manualmente. Essa opção aparecerá se você selecionar Cluster do MID específico no campo Seleção de MID.
        Armazenamento externo de credenciais Opção para usar o armazenamento externo de credenciais CyberArk. Quando você seleciona essa opção, o MID Server obtém as credenciais do OAuth 2.0 (ID e segredo do cliente) do armazenamento externo de credenciais.
        Importante:
        Confirme se a opção está selecionada.
        ID da credencial Identificador da conta CyberArk que contém os detalhes do ID e do segredo do cliente. Para exibir o procedimento para obter o identificador de credencial, consulte Como configurar credenciais OAuth 2.0 no CyberArk.
        No campo "ID da credencial", digite uma expressão usando um desses formatos.
        • Se todas as suas credenciais estiverem no mesmo cofre, configure o nome desse cofre no arquivo config.xml do MID Server usando o parâmetro ext.cred.safe_name e, em seguida, especifique o ID da credencial apenas por nome, como <ID da credencial>.
        • Para nomear credenciais para uma determinada plataforma que reside em um cofre específico, defina o ID de credencial como <safe>:<credential ID>:<platform ID>.
        • Se as suas credenciais estiverem em vários cofres, especifique o ID da credencial neste formato: <cofre>:<ID da credencial>.
        URL do token OAuth URL que especifica o endpoint para obter o token de acesso do servidor OAuth.
      14. Selecione Configurar conexão.
    2. Configure uma conexão manualmente.
      1. Navegar até Todos > OAuth de Sistema > Registro de aplicações.
      2. Selecione Novo.
      3. Selecione Conectar-se a um provedor de OAuth de terceiros usando um cofre externo.
      4. Preencha o formulário
        Tabela 3. Detalhes do novo registro de aplicação
        Campo Descrição
        Nome Nome para identificar o registro da aplicação. Por exemplo, digite: solicitação de token OAuth 2.0 via app MID.
        Aplicação Opção para especificar os nomes das aplicações que podem acessar esse registro de aplicação. O campo é somente leitura.
        Tipo de concessão padrão Método padrão para que a aplicação cliente obtenha o token de acesso do servidor OAuth. O tipo de concessão padrão e somente leitura é "Credenciais do cliente".
        Acessível de Opção para especificar quais aplicações podem acessar esse registro de aplicação.
        URL de token URL que especifica o endpoint para obter o token de acesso do servidor OAuth.
        Enviar credenciais Opção para especificar o método de envio do OAuth 2.0 no corpo da solicitação.
        Comentários Insira comentários relacionados.
      5. Na coluna Escopo do OAuth, crie um ou mais escopos do OAuth seguindo as etapas abaixo.
        1. Na coluna "Nome", clique duas vezes no campo e insira um nome de escopo do OAuth.
        2. Na coluna "Escopo do OAuth", clique duas vezes no campo e insira o escopo.
      6. Selecione Enviar.
        Você criou um perfil de entidade do OAuth e o registro da aplicação.
      7. Navegar até Todos > IntegrationHub > Conexões e Credenciais > Credenciais.
      8. Selecione Novo.
      9. Selecione Credenciais do OAuth 2.0.
      10. Selecione Exibição de armazenamento externo.
        Importante:
        Somente selecione Exibição de armazenamento externo se a exibição for diferente de um formulário de armazenamento externo de credenciais do OAuth 2.0.
      11. Preencha o formulário
        Tabela 4. Credenciais do OAuth 2.0
        Campo Descrição
        Nome Nome do registro da credencial.
        Aplica-se a Opção para especificar se o registro da credencial é aplicável a todos os MID Servers ou a um MID Server específico. Em caso de MID Servers específicos, adicione-os.

        Escolha dentre as seguintes opções.

        • Todos os MID Servers: o MID Server é selecionado automaticamente de uma coleção de MID Servers.
        • MID Servers específicos: opção para especificar um ou mais MID Servers.
        MID Servers Opção para especificar um ou mais MID Servers.
        Nota:
        Esse campo aparecerá se você selecionar MID Servers específicos no campo "Aplica-se a".
        Ativo Opção para especificar se o registro da credencial está disponível para uso. Por padrão, ele fica disponível.
        Perfil de entidade OAuth Opção para especificar um perfil de entidade OAuth que a credencial usa. Selecione o perfil de entidade OAuth que você criou acima. Consulte Como configurar um perfil de entidade OAuth.
        Armazenamento externo de credenciais Opção para especificar que as credenciais sejam armazenadas em um armazenamento externo e não na instância da ServiceNow.
        Importante:
        Confirme se a opção está selecionada.
        ID da credencial Opção para especificar o identificador de credencial da conta CyberArk que contém o ID e o segredo do cliente. Para exibir o procedimento para obter o identificador de credencial, consulte Como configurar credenciais OAuth 2.0 no CyberArk.
        Cofre de armazenamento de credenciais Opção para especificar o nome do cofre de armazenamento externo de credenciais. Verifique se você selecionou CyberArk.
      12. Selecione Enviar.
        Você criou o registro da credencial.
      13. Crie um alias de conexão e credencial.
        Para saber as etapas, consulte Crie um alias de Conexão e Credenciais.
      14. Navegar até Todos > IntegrationHub > Conexões.
      15. Selecione Novo.
      16. Selecione Conexão HTTP(s).
      17. Preencha o formulário
        Tabela 5. Formulário de conexão
        Campo Descrição
        Nome O nome exclusivo dessa conexão HTTP(s).
        Ativo Opção para definir como ativa a conexão que você está criando. A opção é selecionada por padrão.
        Credencial Selecione o registro de credencial usado para autorizar a conexão. Selecione a credencial que você criou acima.
        Alias de conexão Selecione o registro de alias a ser associado a esta conexão. Usar um alias permite que você atualize o registro de conexão sem precisar reconfigurar nenhuma ação ou atividade que use o alias.
        Construtor de URL Insira manualmente o URL de conexão ou use o sistema para construir o URL baseado em entradas. O padrão é desmarcado. Se verificado, o URL de conexão é calculado dos seguintes campos:
        • Autenticação mútua — Marque a caixa, se a autenticação mútua for usada.
        • Protocolo — se a autenticação mútua não for usada, insira o protocolo. O padrão é HTTPs.
        • Perfil de protocolo — Se a autenticação mútua for usada, insira o perfil de protocolo de sys_protocol_profile.
        • Host
        • Porta
        • Caminho base — Caminho da cadeia de caracteres de conexão.
        Nota:
        Se a autenticação mútua estiver marcada, o URL de conexão será criado: Protocolo + :// + host:port +URL. Se a autenticação mútua estiver desmarcada, a URL de conexão será criada desta forma: Perfil do protocolo + :// + host:porta +URL
        URL de conexão Se o construtor de URL estiver desmarcado, insira o URL de conexão neste campo.
        Nota:
        Se a autenticação mútua estiver marcada, o URL de conexão será criado: Protocolo + :// + host:port +URL. Se a autenticação mútua estiver desmarcada, a URL de conexão será criada desta forma: Perfil do protocolo + :// + host:porta +URL
        Usar MID Server Opção para especificar que você deseja enviar solicitações de token OAuth por meio de um MID Server.
        Importante:
        Confirme se a opção está selecionada.
        Tempo limite de conexão Número de milissegundos que o sistema espera por uma conexão de host bem-sucedida. Se uma conexão bem-sucedida não ocorrer durante esse tempo, a solicitação de conexão expirará. Deixe este campo em branco para usar o valor de tempo limite de conexão padrão do sistema.
        Seleção de MID Opção para especificar uma das seguintes opções.
        • Selecionar automaticamente o MID Server: seleciona dentre os MID Servers com base nos critérios de MID Server, independentemente de eles serem ou não membros de um cluster.
        • MID Server específico: selecione um MID Server manualmente.
        • Cluster do MID específico: a reatribuição automática para outro MID Server somente seleciona dentre membros do cluster especificado.
        Importante:
        Confirme se o MID Server que você selecionou reside na mesma máquina que o Cliente CyberArk AIM que está configurado para acessar o cofre CyberArk. Consulte Configure o cofre da CyberArk e instale a API AIM.
        MID Server Selecione um MID Server manualmente. Essa opção aparecerá se você selecionar "MID Server específico" no campo "Seleção de MID".
        Cluster do MID Selecione um cluster do MID manualmente. Essa opção aparecerá se você selecionar "Cluster do MID específico" no campo "Seleção de MID".
        Aplicação de MID Selecione uma aplicação MID manualmente.
      18. Selecione Enviar.
        Você criou um registro de conexão HTTP(s).
      19. Navegar até Todos > Automação de Processo > IntegrationHub > Painel de Conexões.
      20. No campo "Pesquisar todas as conexões", digite o nome do registro de conexão que você criou.
        O registro do alias de conexão será exibido.
        Figura 1. O registro de conexão do OAuth 2.0 é criado
        O registro de conexão OAuth 2.0 foi criado.
        O registro de conexão do OAuth 2.0 é criado.