Usar OAuth para criar credenciais de pipeline

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

    • Crie registros de credenciais em cada uma das instâncias para habilitar o uso do OAuth no pipeline.

    Antes de Iniciar

    Conclua as tarefas em Criar endpoints da API OAuth para clientes externos e Criar registros de provedor OAuth de terceiros.

    No canto superior direito da instância, certifique-se de definir o escopo da aplicação como Global.

    Abra todas as suas instâncias (desenvolvimento, teste, produção e assim por diante) em guias separadas do navegador.

    Função necessária: administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Para configurar as credenciais corretamente, você deve criar registros para cada uma das instâncias de produção e de não produção em sua instância de produção. Em seguida, você deve criar um registro para sua instância de produção em cada uma das instâncias de não produção, conectando-as todas. Use os vídeos em cada seção para acompanhar as etapas. Comece na sua instância de produção.

    Procedimento

    1. Em sua instância de produção, navegue até Todos > Conexões e Credenciais > Aliases de conexão e credencial.
    2. Selecione Novo.
    3. Altere o Tipo para Credencial.
    4. No campo Nome, insira Pipeline Dev OAuth.
    5. Selecione Enviar.
    6. Reabra o registro que você acabou de criar (OAuth de desenvolvimento de pipeline).
    7. Na lista relacionada Credenciais, selecione Novo.
    8. Selecione Credenciais OAuth 2.0.
    9. No formulário, preencha os campos.
      Tabela 1. Formulário de credenciais OAuth 2.0
      Campo Ação
      Nome Insira Dev OAuth.
      Perfil de Entidade OAuth Pesquise e selecione o perfil padrão de Conexão de instância de desenvolvimento.
    10. Selecione Enviar.
    11. Reabra o registro de credencial do OAuth de desenvolvimento.
      Um erro esperado é exibido, direcionando você para verificar a configuração do OAuth e selecionar Obter token do OAuth para solicitar um novo token.
    12. Em Links relacionados, selecione Obter token OAuth.
      Uma instância de desenvolvimento é aberta solicitando a conexão com sua conta ServiceNow.
    13. Selecionar Permitir.
    14. Voltar para a lista Aliases de conexão e credencial (Todos > Conexões e Credenciais > Aliases de conexão e credencial).
    15. Selecione Novo.
    16. Altere o Tipo para Credencial.
    17. No campo Nome, insira Teste de pipeline OAuth.
    18. Selecione Enviar.
    19. Reabra o registro que você acabou de criar (Teste de pipeline OAuth).
    20. Na lista relacionada Credenciais, selecione Novo.
    21. Selecione Credenciais OAuth 2.0.
    22. No formulário, preencha os campos.
      Tabela 2. Formulário de credenciais OAuth 2.0
      Campo Ação
      Nome Insira Testar OAuth.
      Perfil de Entidade OAuth Pesquise e selecione o perfil padrão Testar conexão da instância.
    23. Selecione Enviar.
    24. Reabra o registro de credencial do OAuth de teste.
      Um erro esperado é exibido, direcionando você para verificar a configuração do OAuth e selecionar Obter token do OAuth para solicitar um novo token.
    25. Em Links relacionados, selecione Obter token OAuth.
      Uma instância de teste é aberta solicitando conexão com sua conta ServiceNow.
    26. Selecionar Permitir.
    27. Voltar para a lista Aliases de conexão e credencial (Todos > Conexões e Credenciais > Aliases de conexão e credencial).
    28. Selecione Novo.
    29. Altere o Tipo para Credencial.
    30. No campo Nome, insira Pipeline Prod OAuth.
    31. Selecione Enviar.
    32. Reabra o registro que você acabou de criar (OAuth de produção de pipeline).
    33. Na lista relacionada Credenciais, selecione Novo.
    34. Selecione Credenciais OAuth 2.0.
    35. No formulário, preencha os campos.
      Tabela 3. Formulário de credenciais OAuth 2.0
      Campo Ação
      Nome Insira OAuthde produção .
      Perfil de Entidade OAuth Pesquise e selecione o perfil padrão de Conexão de instância de produção.
    36. Selecione Enviar.
    37. Reabra o registro de credencial do Prod OAuth.
      Um erro esperado é exibido, direcionando você para verificar a configuração do OAuth e selecionar Obter token do OAuth para solicitar um novo token.
    38. Em Links relacionados, selecione Obter token OAuth.
      Uma instância de produção é aberta solicitando conexão com sua conta ServiceNow.
    39. Selecionar Permitir.
    40. Opcional: Se você tiver outras instâncias de não produção (preparação etc.), crie um registro de credencial para cada uma delas em sua instância de produção usando os métodos acima.
      Importante:
      Depois de concluir as etapas acima em sua instância de produção, siga as etapas abaixo para criar um registro de credencial em cada uma das instâncias de não produção, conectando-as à sua instância de produção. Conclua as próximas etapas em sua instância de desenvolvimento.
    41. Em sua instância de desenvolvimento, navegue até Todos > Conexões e Credenciais > Aliases de conexão e credencial.
    42. Selecione Novo para criar um registro para conectar sua instância de desenvolvimento à produção.
    43. Altere o Tipo para Credencial.
    44. No campo Nome, insira Pipeline Prod OAuth.
    45. Selecione Enviar.
    46. Reabra o registro que você acabou de criar (OAuth de produção de pipeline).
    47. Na lista relacionada Credenciais, selecione Novo.
    48. Selecione Credenciais OAuth 2.0.
    49. No formulário, preencha os campos.
      Tabela 4. Formulário de credenciais OAuth 2.0
      Campo Ação
      Nome Insira OAuthde produção .
      Perfil de Entidade OAuth Pesquise e selecione o perfil padrão de Conexão de instância de produção.
    50. Selecione Enviar.
    51. Reabra o registro de credencial do Prod OAuth.
      Um erro esperado é exibido, direcionando você para verificar a configuração do OAuth e selecionar Obter token do OAuth para solicitar um novo token.
    52. Em Links relacionados, selecione Obter token OAuth.
      Uma instância de produção é aberta solicitando conexão com sua conta ServiceNow.
    53. Selecionar Permitir.
      Importante:
      Conclua as próximas etapas em sua instância de teste.
    54. Em sua instância de teste, navegue até Todos > Conexões e Credenciais > Aliases de conexão e credencial.
    55. Selecione Novo para criar um registro para conectar sua instância de teste à produção.
    56. Altere o Tipo para Credencial.
    57. No campo Nome, insira Pipeline Prod OAuth.
    58. Selecione Enviar.
    59. Reabra o registro que você acabou de criar (OAuth de produção de pipeline).
    60. Na lista relacionada Credenciais, selecione Novo.
    61. Selecione Credenciais OAuth 2.0.
    62. No formulário, preencha os campos.
      Tabela 5. Formulário de credenciais OAuth 2.0
      Campo Ação
      Nome Insira OAuthde produção .
      Perfil de Entidade OAuth Pesquise e selecione o perfil padrão de Conexão de instância de produção.
    63. Selecione Enviar.
    64. Reabra o registro de credencial do Prod OAuth.
      Um erro esperado é exibido, direcionando você para verificar a configuração do OAuth e selecionar Obter token do OAuth para solicitar um novo token.
    65. Em Links relacionados, selecione Obter token OAuth.
      Uma instância de produção é aberta solicitando conexão com sua conta ServiceNow.
    66. Selecionar Permitir.
    67. Opcional: Se você tiver outras instâncias de não produção (preparação etc.), crie um registro de credencial nessa instância para produção usando as etapas 54 a 66.

    O que Fazer Depois

    Agora que você criou todos os registros de credenciais que conectam suas instâncias, você pode usar esses registros para configurar seus ambientes de pipeline. Para obter mais informações, consulte Configurar seus ambientes de pipeline.