Credenciais OAuth 2.0 para aplicações GitHub - Código de autorização

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 4 min. de leitura

    • Execute as etapas a seguir para integrar seus aplicativos GitHub usando o código de autorização.

    Antes de começar

    Função necessária:
    • oauth_admin em Velocidade de mudança para DevOps.
    • Conta de administrador em GitHub.
    Nota:
    Somente repositórios de nível de usuário são compatíveis. Você deve ter acesso a todos os repositórios GitHub que deseja configurar em Velocidade de mudança para DevOps usando o código de autorização.

    O tipo de concessão do código de autorização OAuth é compatível com o GitHub e o GitHub Enterprise com MID Server.

    Configure o aplicativo GitHub em sua conta GitHub (código de autorização)

    Crie um app GitHub personalizado de sua conta GitHub para habilitar a autenticação OAuth 2.0 com sua instância ServiceNow.

    Antes de Iniciar

    GitHub requisito: GitHub app configurado para integração com ServiceNow

    Função necessária: nenhuma função de instância necessária

    Por Que e Quando Desempenhar Esta Tarefa

    Conclua essas etapas na sua conta GitHub. Confira Prédio GitHub Apps no site do desenvolvedor GitHub para obter instruções sobre como criar e configurar aplicações personalizadas.

    Procedimento

    1. Na sua conta GitHub, crie seu app GitHub navegando até Configurações do desenvolvedor > Aplicações do GitHub.
    2. No campo URL da página inicial, insira https://<instance-name> .service-now.com .
    3. No campo URL de retorno de chamada de autorização do usuário, insira https://<instance-name> .service-now.com/oauth_redirect.do .
    4. Na seção Identificação e autorização de usuários, desmarque o campo Tokens de autorização do usuário expirados.
    5. Na seção Webhook, desmarque o campo Ativo.
    6. Deixe os campos restantes em branco (padrão).
    7. Na seção Permissões do repositório, defina essas configurações.
      Ação Somente leitura
      Verificações Somente leitura
      Conteúdos Somente leitura
      Implantações Ler e gravar
      Ambientes Somente leitura
      Metadado Somente leitura
      Solicitações de extração Somente leitura
      Segredos Somente leitura
      Webhooks Ler e gravar
      Nota:
      São necessárias permissões de leitura e gravação para configurar webhooks de ServiceNow.
    8. Deixe as permissões restantes como Sem acesso (padrão).
    9. Instale o aplicativo GitHub recém-criado nas contas de sua escolha.

    Adicionar ID de cliente à propriedade de DevOps

    Depois de configurar o app GitHub, você deve garantir que o prefixo do ID do cliente (primeiros 3 ou mais caracteres do ID) seja adicionado à propriedade do DevOps: especificador de ID de cliente para o app GitHub.

    Antes de Iniciar

    Função necessária: sn_devops.admin

    Procedimento

    1. Navegar até Espaços > Espaço de mudança de DevOps > Administração > Configuração do sistema > Propriedades.
    2. Altere o Escopo da aplicação para Modelo de dados do DevOps.
    3. Pesquise a propriedade: especificador de ID de cliente para app GitHub [sn_devops.github_oauth_client_id_specifier].
    4. Insira o prefixo do ID do cliente (primeiros 3 ou mais caracteres do ID) do seu app GitHub na propriedade.
    5. Selecione Save (Salvar).

    Registrar GitHub como um provedor OAuth (código de autorização)

    Use as informações geradas durante a configuração da conta do aplicativo GitHub para registrar GitHub como um provedor OAuth e permitir que a instância solicite tokens OAuth 2.0.

    Antes de Iniciar

    Função necessária: administrador, sn_devops.admin

    Procedimento

    1. Navegar até Tudo > 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 vazio.
    4. Preencha o formulário.
      Campo Valor necessário
      Nome Insira qualquer nome para identificar exclusivamente o registro. Por exemplo, insira Meu provedor de apps do GitHub.
      ID de cliente Insira o ID de cliente do seu app GitHub (dica: disponível na seção Sobre da configuração do app GitHub em GitHub ).
      Segredo do cliente Insira o segredo do cliente do app GitHub (dica: disponível na seção Sobre da configuração do app GitHub em GitHub ).
      Script da API OAuth Selecione OAuthDevOpsGitHubHandler.
      Tipo de concessão padrão Selecione Código de autorização.
      URL de Autorização

      Insira https://github.com/login/oauth/authorize.

      Para uma implantação no local, use o URL do host GitHub apropriado.
      URL de Token

      Insira https://github.com/login/oauth/access_token.

      Para uma implantação no local, use o URL do host GitHub apropriado.
    5. Deixe o restante dos campos de formulário como padrão.
      Formulário Registro de aplicações
    6. 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 a URL de redirecionamento (Dica: ela deve corresponder à URL de retorno de chamada de autorização do usuário fornecida anteriormente na configuração do aplicativo GitHub ).
      • O sistema preenche o perfil de entidade OAuth com o tipo de concessão como código de autorização. Por exemplo, o perfil de entidade OAuth é criado com o nomepadrão, Meu provedor de apps GitHub default_profile

    Criar um registro de credencial para o provedor de aplicações GitHub (código de autorização)

    Crie um registro de credencial para o provedor de aplicações GitHub criado anteriormente para autorizar ações.

    Antes de Iniciar

    Função necessária: administrador, credential_admin

    Procedimento

    1. Navegar até Tudo > 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 de Credenciais OAuth 2.0 vazio.
    4. Preencha estes valores.
      Campo Valor necessário
      Nome Insira qualquer nome para identificar exclusivamente o registro. Por exemplo, insira Minha credencial do app GitHub.
      Ativo Habilitar
      Perfil de Entidade OAuth Selecione o perfil de entidade OAuth padrão que você criou anteriormente.
      Aplica-se a Selecione os MID Servers que podem usar esta credencial. Por exemplo: selecione Todos os MID Servers.
      Nota:
      Você deve se conectar à sua instância da ferramenta GitHub usando o MID Server para usar esta credencial.
      Pedido Selecione a ordem para aplicar esta credencial. Por exemplo: insira 100.
    5. Salve o registro.
    6. Clique no link relacionado Obter token OAuth para gerar o token OAuth.