Configurar o Spoke da Salesforce

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 10 min. de leitura

    • Integre sua conta Salesforce à sua instância do ServiceNow. Crie uma aplicação OAuth personalizada em Salesforce e autentique as solicitações de ServiceNow.

    Antes de Iniciar

    • Solicitar uma assinatura Integration Hub
    • Ativação do Spoke da Salesforce
    • Função necessária: administrador
    Nota:
    Dois procedimentos de configuração de spoke são descritos aqui. Execute um dos procedimentos de acordo com seus requisitos.
    Nota:
    Não exclua o registro de alias de conexão padrão. Isso pode resultar em um comportamento inesperado. Configure sua conexão usando o alias de conexão padrão.

    Criação de um aplicativo conectado no Salesforce

    Crie um aplicativo conectado em sua conta Salesforce para habilitar a autenticação OAuth 2.0 com o Spoke da Salesforce.

    Antes de Iniciar

    • Salesforce conta
    • Função necessária: administrador do Salesforce

    Por Que e Quando Desempenhar Esta Tarefa

    Conclua essas etapas na sua conta Salesforce. Consulte Como criar um aplicativo conectado em Salesforce Fórum do Trailblazer Documentação do para obter instruções sobre como criar e configurar apps conectados.

    Procedimento

    1. Na sua conta Salesforce, crie um app conectado.
    2. Configure a aplicação conectada para permitir que a aplicação Salesforce compartilhe dados com a instância ServiceNow.
      1. Selecione Habilitar configurações do OAuth e defina as configurações de autenticação.
      2. Se você quiser configurar o spoke usando a chave de assinatura JWT, selecione Usar assinaturas digitais e carregue um certificado Java KeyStore (JKS).
      3. Selecione os escopos do OAuth:
        • Acessar e gerenciar seus dados (API)
        • Execute solicitações em seu nome a qualquer momento (refresh_token, offline_access)
      4. Especifique ServiceNow URL de instância em URL de retorno de chamada neste formato: https://<instance-name> .service-now.com/oauth_redirect.do
      5. Depois de criar o aplicativo conectado, em Políticas de OAuth na página Editar políticas, defina estes valores:
        Campo Valor
        Usuários permitidos Usuários aprovados pelo administrador são pré-autorizados
        Restrições de IP Abrandar restrições de IP
      6. Configure o provisionamento de usuário para o aplicativo conectado de acordo com seus requisitos.
    3. Registre os valores de Chave do consumidor e Segredodo consumidor.
      Nota:
      • Atribua o perfil e o conjunto de permissões de acordo com seus requisitos.
      • Nas restrições de IP do aplicativo OAuth, especifique as políticas do OAuth para garantir que o aplicativo conectado funcione como um aplicativo padrão.

    Resultado

    O app conectado é criado em Salesforce.

    Opção 1: configurar o Spoke da Salesforce usando o modelo de autorização OAuth

    Integre sua conta Salesforce à sua instância do ServiceNow. Crie uma aplicação OAuth personalizada em Salesforce e autentique solicitações de ServiceNow usando o modelo de autorização OAuth.

    Antes de Iniciar

    Procedimento

    1. Navegar até Conexões e Credenciais > Aliases de conexão e credencial.
    2. Abra o registro, Salesforce.
    3. Clique no link relacionado Criar nova conexão e credencial.
    4. No formulário, preencha estes valores.
      Tabela 1. Formulário Criar Conexão e Credencial
      Campo Descrição
      Nome da conexão Nome para identificar o registro de conexão.
      URL de conexão (URL da instância) URL base para se conectar à sua instância Salesforce neste formato: https://<instance-name> .salesforce.com
      ID do cliente OAuth Chave do consumidor que você gerou durante a configuração do app conectado Salesforce.
      Segredo do cliente OAuth Segredo do consumidor que você gerou durante a configuração do app conectado Salesforce.
      URL de redirecionamento do OAuth URL do provedor OAuth para o qual os usuários são redirecionados após a autenticação. Este campo é preenchido automaticamente.
    5. Clique em Criar e obter token do OAuth.
      A caixa de diálogo de autenticação OAuth2 é exibida.
    6. Faça login na conta de administrador Salesforce que você usou para criar sua aplicação Salesforce.
      Sua instância ServiceNow cria um token OAuth para Salesforce e retorna automaticamente para o formulário de perfil de integração.
    7. Clique em Publicar.

    Opção 2: configurar o Spoke da Salesforce usando a chave de assinatura JWT

    Integre sua conta Salesforce à sua instância do ServiceNow. Crie uma aplicação OAuth personalizada em Salesforce e autentique solicitações de ServiceNow usando a chave de assinatura JWT.

    Antes de Iniciar

    Anexar um certificado Java Key Store ao Spoke da Salesforce

    Habilite a autenticação de token JSON Web Token (JWT) ao portador anexando um certificado Java KeyStore (JKS) válido ao Spoke da Salesforce.

    Antes de Iniciar

    • Certificado Java KeyStore válido
    • Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Definição do Sistema > Certificados.
    2. Clique em Nova.
    3. No formulário, preencha os campos.
      Tabela 2. Formulário de Certificado X.509
      Campo Descrição
      Nome Nome para identificar exclusivamente o registro. Por exemplo, Certificado do Salesforce.
      Notificação de expiração Opção para enviar uma notificação quando o certificado estiver prestes a expirar.
      Notificar no vencimento Os usuáriossão notificados quando o certificado expira.
      Aviso emitido antes do vencimento (em dias) Número de dias para enviar uma notificação antes que o certificado expire.
      Ativo Opção para usar ativamente o certificado.
      Formato Formato do certificado. A instância suporta os formatos PEM e DER.
      Tipo Tipo de certificado. Selecione Armazenamento de chaves Java.
      Válido de Data a partir da qual o certificado é válido.
      Expira Data em que o certificado expira.
      Expira em dias Número de dias até o certificado expirar.
      Senha do armazenamento de chaves Senha associada ao certificado.
      Descrição resumida Resumo sobre o certificado.
      Certificado PEM Conteúdos do certificado X509.
    4. Clique no ícone de anexos (ícone de anexos) e anexe um certificado JKS.
    5. Clique em Validar armazenamentos/certificados.

    Resultado

    O certificado JKS é criado e anexado ao Spoke da Salesforce.

    Criar uma chave de assinatura JWT para o Spoke da Salesforce

    Crie uma chave de assinatura JSON Web Token (JWT) para atribuir ao seu certificado Java KeyStore.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > OAuth de Sistema > Chaves de JWT.
    2. Clique em Nova.
    3. No formulário, preencha os campos.
      Tabela 3. Formulário Chaves JWT
      Campo Descrição
      Nome Nome para identificar exclusivamente a chave de assinatura JWT. Por exemplo, Chaves JWT do Salesforce.
      Armazenamento de chaves de assinatura Certificado JKS válido anexado na tarefa anterior. Por exemplo, Certificado do Salesforce.
      ID de chave ID da chave para identificar qual chave é usada quando várias chaves são usadas para assinar tokens.
      Aplicação Escopo da aplicação que contém este registro. Selecione Spoke da Salesforce.
      Algoritmo de assinatura Algoritmo para assinar com a chave JWT.
      Senha da chave de assinatura Senha associada à chave de assinatura.
      Ativo Opção para usar ativamente o certificado.
    4. Clique em Enviar.

    Resultado

    A chave JWT é criada e atribuída ao certificado JKS.

    Criar um provedor JWT para o Spoke da Salesforce

    Adicione um provedor JSON Web Token (JWT) à sua instância da ServiceNow.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > OAuth de Sistema > Provedores JWT.
    2. Clique em Nova.
    3. No formulário, preencha os campos.
      Tabela 4. Formulário de Provedor JWT
      Campo Descrição
      Nome Nnome para identificar exclusivamente o provedor JWT. Por exemplo, Provedor JWT do Salesforce.
      Intervalo de Vencimento (s) Número, em segundos, para definir o tempo de vida dos tokens do provedor JWT.
      Configuração de Assinatura. Chave de assinatura JWT da etapa anterior. Por exemplo, Chaves JWT do Salesforce.
    4. Clique com o botão direito no cabeçalho do formulário e clique em Salvar.
      As listas relacionadas a Declarações padrão e Declarações personalizadas são exibidas.
    5. Na lista relacionada Declarações padrão, insira valores para iss, sube aud.
      Consulte Fluxo de portador OAuth 2.0 JWT para integração de servidor a servidor em Salesforce Fórum do Trailblazer Documentação para obter instruções.
    6. Clique em Atualizar.

    Resultado

    O provedor JWT é adicionado à sua instância ServiceNow.

    Registrar Salesforce como um provedor OAuth

    Use as informações geradas durante a configuração do app conectado Salesforce para registrar Salesforce como um provedor OAuth e habilitar a instância para solicitar tokens OAuth 2.0.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > OAuth de Sistema > Registro de aplicações.
    2. Clique em Nova.
      O sistema exibe a mensagem Que tipo de aplicação OAuth?
    3. Selecione Conectar-se a um provedor OAuth de terceiros.
      O sistema exibe um formulário de Registros de aplicações em branco.
    4. No formulário, preencha os campos.
      Campo Valor necessário
      Nome Nome para identificar exclusivamente o registro. Por exemplo, insira Salesforce OAuth.
      ID de cliente Chave do consumidor que você gerou durante a configuração do app conectado Salesforce.
      Segredo do cliente Segredo do consumidor que você gerou durante a configuração do app conectado Salesforce.
      Script do API da OAuth Script opcional para personalizar solicitação e resposta.
      Tipo de concessão padrão Tipo de concessão usado para estabelecer o token. Selecione Portador JWT.
      Tempo de vida do token de atualização Tempo, em segundos, em que o token de atualização é válido. O tempo padrão é 8.640.0000 segundos.
      PKCE necessário Opção para permitir que clientes públicos exijam o PKCE para uma autorização.
      Nota:
      Você pode usar somente o Código de autorização como o Tipo de concessão padrão quando o PKCE estiver habilitado.
      Aplicação Escopo da aplicação que contém este registro. Selecione Salesforce.
      Acessível de Escopo da aplicação a partir do qual este registro fica acessível.
      Ativo Opção para usar ativamente o registro da aplicação.
      URL de Autorização Este campo deve ser deixado em branco.
      URL de Token Endpoint do token do servidor OAuth.
      • Para instância de produção, insira https://login.salesforce.com/services/oauth2/token.
      • Para instância de área restrita, insira https://test.salesforce.com/services/oauth2/token
      URL de revogação do token Este campo deve ser deixado em branco.
      URL de redirecionamento Este campo deve ser deixado em branco.
    5. Clique com o botão direito no cabeçalho do formulário e clique em Salvar.
      • O sistema valida as credenciais do OAuth e preenche o campo Redirecionar URL .
      • O sistema preenche o perfil de entidade OAuth com tipo de concessão como JWT Bearer. Por exemplo, o perfil de entidade OAuth é criado com o nomepadrão, provedor JWT do Salesforce default_profile .
    6. Copie o valor de do campo URL de redirecionamento .
    7. Clique em Atualizar.
    8. Faça login na sua conta Salesforce para editar a configuração do app conectado.
      Veja o Salesforce Fórum do Trailblazer Documentação para obter instruções.
    9. Cole o valor da URL de redirecionamento na URL de retorno de chamada do app Salesforce conectado.
      Por exemplo, cole https://<instance-name> .service-now.com/oauth_redirect.do .

    Resultado

    A instância pode solicitar tokens OAuth 2.0 para o spoke Salesforce.
    Nota:
    Quando um token OAuth expira, o spoke gera automaticamente um novo token na maioria dos casos. Se um token expirar e não for gerado novamente, um usuário com a função administrador poderá gerar novamente o token OAuth do spoke.

    Criar registros de redenciais cpara Spoke da Salesforce

    Crie registros de credenciais para o Salesforce app conectado que você criou. Os aliases de conexão e credencial [ Spoke da Salesforce usam essas credenciais para autorizar ações.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Conexões e Credenciais > Credenciais.
    2. Clique em Nova.
      O sistema exibe a mensagem Que tipo de credenciais você deseja criar? .
    3. Selecione Credenciais OAuth 2.0.
      A janela pop-up exibe um formulário em branco de Credenciais OAuth 2.0.
    4. No formulário, preencha os campos.
      Campo Valor necessário
      Nome Nome para identificar exclusivamente o registro. Por exemplo, insira Credenciais do Salesforce.
      Ativo Opção de usar ativamente o registro de credencial.
      Perfil de Entidade OAuth Perfil OAuth que você criou ao registrar o aplicativo Salesforce conectado como um provedor OAuth. Por exemplo, selecione Salesforce OAuth default_profile.
      Aplica-se a MID Servers que podem usar esta credencial. Por exemplo: selecione Todos os MID Servers.
      Ordem A ordem na qual aplicar esta credencial. Por exemplo: insira 100.
    5. Salve o registro.
    6. Clique no link relacionado Obter token OAuth para gerar o token OAuth.

    Resultado

    O registro de credencial para Spoke da Salesforce foi criado.

    Criar cregistros de conexão para Spoke da Salesforce

    Crie cregistros de conexão para sua Salesforce conta. Os aliases de conexão e credencial [ Spoke da Salesforce usam essas conexões para executar ações em Salesforce.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > Conexões e Credenciais > Aliases de conexão e credencial.
    2. Aberto para o registro do Salesforce.
    3. Na guia Conexões, clique em Novo.
      O sistema exibe um formulário de conexão HTTP(s) em branco.
    4. Insira estes valores.
      Campo Valor necessário
      Nome Nome para identificar o registro da conexão com exclusividade. Por exemplo, insira Salesforce Connection.
      Credenciais Registro de credencial que você que criou para Salesforce. Por exemplo, selecione Credenciais do Salesforce.
      Alias de conexão Registro de alias associado a esta conexão.
      Construtor de URL
      Nota:
      Não marque a caixa de seleção.
      URL de Conexão URL base para se conectar à sua instância Salesforce. Por exemplo, https://<instance-name> .salesforce.com .
      Usar MID Server Opção para usar o MID Server. Se você selecionar esta caixa de seleção, defina os campos na lista relacionada Configuração avançada do MID Server.
      Ativo Opção para usar a conexão ativamente.
      Domínio Domínio em que a ação ou atividade é executada.
    5. Clique com o botão direito no cabeçalho do formulário e clique em Salvar.
    6. Certifique-se de que api_version esteja definido como v45.0 em na lista relacionada Atributos.

    Resultado

    O Spoke da Salesforce está configurado e integrado à instância ServiceNow.