Conectar-se a um provedor Git usando OAuth 2.0 com o ServiceNow IDE

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 4 min. de leitura
  • Configure um registro de aplicação OAuth 2.0 e credenciais para se conectar ao seu provedor Git do ServiceNow IDE.

    Configurar um registro de aplicação OAuth 2.0 para o ServiceNow IDE

    Configure como o ID e o segredo do cliente são enviados para o provedor OAuth 2.0 associado ao seu provedor Git.

    Antes de Iniciar

    Crie uma aplicação OAuth com seu provedor Git, como GitHub, GitLabou Bitbucket, e configure-a para redirecionar para sua instância. Nesta aplicação OAuth, use a URL da instância como a URL da página inicial e https:// <instance> /oauth_redirect.do para o URL de retorno de chamada de autorização.

    Função necessária: administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Para usar a autenticação OAuth 2.0 com ServiceNow IDE, você deve registrar a aplicação OAuth criada a partir do seu provedor Git. Siga este procedimento para configurar um registro de aplicação OAuth [oauth_entity] em sua instância.

    Procedimento

    1. Navegar até Todos > OAuth de Sistema > Registro de aplicações e selecione Novo.
    2. Na página do interceptador, selecione Conectar-se a um provedor OAuth de terceiros.
    3. No formulário, preencha os campos.

      Para obter informações adicionais sobre os campos do formulário, consulte Connect to a third-party OAuth provider.

      Tabela 1. Formulário de registros de aplicações
      Campo Descrição
      Nome Um nome exclusivo para a conexão OAuth de terceiros.
      ID de cliente O ID de cliente da aplicação OAuth no seu provedor Git.
      Segredo do cliente O segredo do cliente da aplicação OAuth no seu provedor Git.
      Script do API da OAuth O script usado para personalizar a solicitação e a resposta ao provedor OAuth externo. Selecione uma das seguintes opções, dependendo do seu provedor Git:
      • GitHub: OauthAPIScriptForGitHub
      • GitLab: OauthAPIScriptForGitLab
      • Bitbucket: OauthAPIScriptForBitbucket
      Nota:
      Para usar outros provedores Git, você pode usar esses scripts como exemplos para criar seu próprio script de API OAuth para seu provedor OAuth. O nome do script deve começar com "Oauth".
      Tipo de concessão padrão O tipo de concessão padrão usado para estabelecer o token. Selecione Código de autorização.

      Um código de autorização é concedido ao cliente para obter um token de acesso, que é usado para obter acesso ao recurso.

      Tempo de vida do token de atualização O tempo, em segundos, que o token de atualização é válido. O tempo padrão é 8.640.0000 segundos.
      Aplicação O escopo da aplicação que contém este registro.
      Acessível de Uma opção para tornar o registro da aplicação acessível de todos os escopos da aplicação ou somente deste escopo.
      Ativo Uma opção para ativar ou desativar a aplicação OAuth.
      URL de Autorização O endpoint do código de autorização OAuth para o seu domínio Git. Por exemplo:
      • GitHub: https://github.com/login/oauth/authorize
      • GitLab: https://gitlab.com/oauth/authorize
      • Bitbucket: https://bitbucket.org/site/oauth2/authorize
      URL de Token O endpoint do token do servidor OAuth para o seu domínio Git. Por exemplo:
      • GitHub: https://github.com/login/oauth/access_token
      • GitLab: https://gitlab.com/oauth/token
      • Bitbucket: https://bitbucket.org/site/oauth2/access_token
      URL de redirecionamento O endpoint de retorno de chamada do OAuth Se estiver vazio, a instância gerará automaticamente um valor de https://<instance> /oauth_redirect.do .
      Usar autenticação mútua Uma opção para usar autenticação mútua. Deixe esta opção desmarcada para desativar o uso da autenticação mútua para solicitação e revogação de token.
      Enviar Credenciais A maneira como o cliente OAuth preenche as credenciais do cliente na solicitação. Selecione Como cabeçalho de autorização básica.
    4. Selecione Enviar.

    O que Fazer Depois

    Os desenvolvedores que usam o ServiceNow IDE devem configurar suas próprias credenciais do OAuth 2.0. Para obter mais informações, consulte Configure as credenciais do OAuth 2.0 para se conectar a um provedor Git com o ServiceNow IDE.

    Configure as credenciais do OAuth 2.0 para se conectar a um provedor Git com o ServiceNow IDE

    Conecte-se a um domínio ou repositório Git usando credenciais OAuth 2.0 para gerenciar aplicações no controle de código-fonte do ServiceNow IDE.

    Antes de Iniciar

    • Um administrador deve configurar como o ID e o segredo do cliente são enviados para o provedor OAuth 2.0 associado ao seu provedor Git. Para obter mais informações, consulte Configurar um registro de aplicação OAuth 2.0 para o ServiceNow IDE.
    • Para configurar credenciais para um repositório em vez de um domínio Git, crie um repositório Git dedicado para a aplicação.

    Função necessária: administrador

    Procedimento

    1. Navegar até Todos > IDE da ServiceNow.
    2. Use um dos seguintes atalhos de teclado para abrir a paleta de comandos:
      • Windows: Ctrl-Shift-P
      • Mac: Cmd-Shift-P
    3. Inserir Git: defina as credenciais Git do IDE e pressione Enter.
    4. No formulário de credencial do Git, selecione OAuth.
    5. No formulário, preencha os campos.
      Tabela 2. Novo formulário de credencial Git
      Campo Descrição
      URL do repositório Git Um nome de domínio do provedor Git ou URL do repositório.

      Se você especificar um nome de domínio do provedor Git, essa credencial será usada para todos os repositórios no domínio.

      Nome de usuário Git Seu nome de usuário Git.
      Selecione um perfil OAuth As credenciais do OAuth 2.0 para seu provedor Git.

      O perfil OAuth é criado com o registro da aplicação, que deve ser configurado por um administrador.

    6. Selecione Enviar.

    Resultado

    Na primeira vez em que você usa um comando Git, você é solicitado a autorizar o usuário do provedor Git.

    O que Fazer Depois

    Depois de inicializar ou clonar um repositório, você pode começar a usar o controle de código-fonte. Para obter mais informações, consulte Como usar o controle de código-fonte no ServiceNow IDE.

    Para gerenciar credenciais Git existentes, use o comando Git: gerenciar credenciais Git na paleta de comandos.