Usar um provedor OAuth de terceiros

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 3 min. de leitura

    • Cada aplicação cliente deve ser registrada na instância para participar da autorização do OAuth.

    Antes de Iniciar

    Função necessária: administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Nota:
    ServiceNow oferece suporte somente a provedores OAuth de terceiros para autorizar solicitações de ServiceNow para APIs de terceiros.
    Por exemplo, convém integrar a um serviço de calendário de terceiros que requer tokens de acesso OAuth 2.0 para ler os eventos programados de um usuário e criar eventos. Configure o serviço de calendário como um provedor OAuth de terceiros. Esta configuração permite que você obtenha um token de acesso do serviço de calendário e use o token para fazer solicitações no serviço de ServiceNow.

    Procedimento

    1. Navegar até Todos > OAuth de Sistema > Registro de aplicações e clique em Novo.
    2. Na página do interceptador, clique em Conectar a um provedor OAuth de terceiros e preencha o formulário.
      Campo Descrição
      Nome Um nome exclusivo que identifica a aplicação a ser acessada.
      ID de cliente O ID exclusivo da aplicação. A instância usa o ID de cliente ao solicitar um token de acesso. Você deve obter o ID do cliente do servidor de autorização.
      Segredo do Cliente [Obrigatório] A cadeia de caracteres do segredo compartilhado que a instância e a aplicação usam para autorizar as comunicações entre si. Se você não inserir o segredo do cliente correto, os tokens não serão emitidos.
      Script do API do OAuth Esta opção permite que você faça referência a uma inclusão de script OAuthUtil alterada. Copie e renomeie o arquivo de inclusão de script OAuthUtil padrão e corrija esta versão para solicitações e respostas específicas para corresponder ao seu provedor OAuth de terceiros. O nome do script corrigido deve ter o prefixo OAuth. Consulte OAuthUtil para adicionar o parâmetro de corpo necessário no método apropriado.
      URL de logotipo O URL que contém uma imagem a ser usada como logotipo da aplicação.
      Tipo de concessão padrão O tipo de concessão:
      • Código de autorização: o código fornecido ao cliente para obter um token de acesso, que é então usado para ter acesso ao recurso. Se você selecionar essa opção, precisará de um URL de autorização (o URL do servidor de autorização).
      • Credenciais de senha do responsável pelo recurso: nome de usuário e senha do usuário tentando obter acesso ao recurso.
      • Credenciais do cliente: ID do cliente e segredo do cliente, ambos usados para obter o token de acesso. Esse método não fornece atualização de tokens.
      • JWT Bearer: um servidor de autorização valida um token JWT, que habilita informações de identidade e segurança a serem compartilhadas entre domínios de segurança.
      • SAML2 Bearer: gera a estipulação SAML2 e, em seguida, troca com o provedor a estipulação para os tokens de acesso.
        Nota:
        Para solicitações de saída para SuccessFactors, use o SAML2 Bearer como tipo padrão de concessão.
      Tempo de vida do token de atualização A duração do token de atualização em segundos.
      Acessível de O escopo da aplicação a partir do qual este registro pode ser acessado.
      Ativo Uma caixa de seleção que indica que o registro da aplicação está ativo.
      URL de Autorização Se você estiver usando o tipo de concessão de código de autorização, o URL do endpoint para autorizar o usuário. Se você estiver acessando outra instância ServiceNow, anexe /oauth_auth.do ao URL.
      URL de Token O local do endpoint do token que a instância usa para recuperar e atualizar tokens. Se você estiver acessando outra instância ServiceNow, anexe /oauth_token.do ao URL.
      Redirecional URL O endpoint da aplicação que recebe o código de autorização. Deixe o campo em branco para que a instância gere automaticamente o URL. Se você estiver acessando outra instância ServiceNow, anexe /oauth_redirect.do ao URL.
      URL de revogação do token O local do endpoint que a instância usa para revogar o token. Se você estiver acessando outra instância, anexe /oauth_revoke.do ao URL.
      Comentários Informações adicionais a serem associadas à aplicação.
      Listas integradas
      Perfis de entidade OAuth Os perfis associados ao provedor OAuth. O perfil inclui o tipo de concessão. Clique no nome do perfil para ir para o formulário Perfil de entidade OAuth.
      Escopos de entidade OAuth Os escopos de entidade associados ao provedor OAuth. O escopo identifica os serviços aos quais a aplicação tem acesso. Clique no nome do escopo para ir para o formulário Escopo da entidade OAuth.
    3. Clique em Enviar.
      O registro é salvo na tabela Registros da aplicação [oauth_entity].

      O sistema cria um registro na tabela Registros da aplicação [oauth_entity] do tipo Provedor OAuth. A instância também gera automaticamente um perfil padrão usando o tipo de concessão especificado, mas sem escopos.

    O que Fazer Depois

    Você pode criar perfis adicionais, cada um com escopos.