Autenticando para uma instância ServiceNow com o ServiceNow SDK

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

    • Autentique-se em uma instância ServiceNow e armazene as credenciais do usuário para acessar a instância em seu sistema com o ServiceNow SDK.

    Depois de instalar o ServiceNow SDK, você pode autenticar em uma instância com a ServiceNow SDK interface de linha de comando (CLI) para começar a desenvolver aplicações e implantá-las em sua instância. Uma instância de não produção deve ser usada para o desenvolvimento de aplicações.

    Você pode usar credenciais básicas ou OAuth 2.0 para autenticar em uma instância. Para usar a autenticação OAuth 2.0, sua instância deve ter ServiceNow IDE (versão 1.1 ou posterior) instalado ou ter a configuração XML necessária importada. Por padrão, as instâncias na versão Yokohama incluem ServiceNow IDE versão 1.1.4 e são compatíveis com o uso da autenticação OAuth 2.0 com ServiceNow SDK.

    Autenticar em uma instância ServiceNow usando a autenticação básica com ServiceNow SDK

    Use a autenticação básica para se conectar a uma instância ServiceNow com o ServiceNow SDK.

    Antes de Iniciar

    Função necessária: administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Este procedimento usa a ServiceNow SDK interface de linha de comando (CLI). Em uma ferramenta de linha de comando, insira now-sdk --help para obter informações sobre os comandos e opções globais disponíveis. Para obter informações adicionais sobre um comando e seus parâmetros, insira o comando e --help ou -h. Por exemplo, now-sdk auth --help. Para obter mais informações sobre a CLI, consulte ServiceNow SDK CLI.

    Procedimento

    1. Abra uma ferramenta de linha de comando no seu sistema.
    2. Especifique a instância para autenticação com o comando auth. 
      now-sdk auth save <alias> --type basic

      Por exemplo:
      now-sdk auth save devuser1 --type basic --default true
    3. No prompt, insira o URL da instância de destino.
    4. Insira seu ServiceNow nome de usuário.

      A função de administrador deve estar atribuída a você.

    5. Insira sua senha.

    Resultado

    O alias e as credenciais são armazenados no conjunto de chaves do dispositivo ou no gerenciador de credenciais do seu sistema. O alias pode ser usado para autenticação com os comandos create, convert, fetche deploy.

    O que Fazer Depois

    Crie uma aplicação com escopo ou converta uma aplicação existente para uso com o ServiceNow SDK. Para obter mais informações, consulte Criar uma aplicação com ServiceNow SDK ou .

    Configure uma instância ServiceNow para autenticação OAuth 2.0 com o ServiceNow SDK

    Importe a configuração para usar a autenticação OAuth 2.0 com o ServiceNow SDK para uma instância.

    Antes de Iniciar

    Importante:
    Este procedimento é necessário somente para instâncias que não têm ServiceNow IDE (versão 1.1 ou posterior) instalado. Por padrão, as instâncias na versão Yokohama incluem ServiceNow IDE versão 1.1.4 e são compatíveis com o uso da autenticação OAuth 2.0 com ServiceNow SDK.

    O usuário Administrador do sistema (admin) padrão deve ser elevado para a função security_admin privilegiada para configurar uma instância para autenticação OAuth 2.0 com o ServiceNow SDK. Para obter mais informações, consulte Elevate to a privileged role.

    Função necessária: security_admin

    Procedimento

    1. Navegue até o artigo Configurando o ServiceNow SDK para autenticação OAuth 2.0 (SSO) no Comunidade ServiceNow.
    2. Baixe o arquivo ZIP anexado e descompacte seu conteúdo.
    3. Importe o XML para sua instância.
      1. Em sua instância, navegue até qualquer lista.
        Qualquer lista pode ser usada porque o arquivo XML contém o nome da tabela de destino dos registros.
      2. Selecione e mantenha pressionado (ou clique com o botão direito do mouse) qualquer título de coluna e selecione Importar XML.
      3. No formulário Importar XML, selecione Escolher arquivo e selecione um dos arquivos XML baixados.
      4. Selecione Carregar.
      5. Repita essas etapas para cada arquivo XML.
      Para obter informações adicionais, confira Import data from XML.

    Resultado

    Os desenvolvedores podem autenticar na instância usando o OAuth 2.0 com o ServiceNow SDK.

    Autenticar em uma instância ServiceNow usando o OAuth 2.0 com o ServiceNow SDK

    Use a autenticação OAuth 2.0 para se conectar a uma instância ServiceNow com o ServiceNow SDK.

    Antes de Iniciar

    Para usar a autenticação OAuth 2.0, sua instância deve ter ServiceNow IDE (versão 1.1 ou posterior) instalado ou ter a configuração XML necessária importada. Por padrão, as instâncias na versão Yokohama incluem ServiceNow IDE versão 1.1.4 e são compatíveis com o uso da autenticação OAuth 2.0 com ServiceNow SDK. Para obter mais informações, consulte Configure uma instância ServiceNow para autenticação OAuth 2.0 com o ServiceNow SDK.

    Função necessária: administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Este procedimento usa a ServiceNow SDK interface de linha de comando (CLI). Em uma ferramenta de linha de comando, insira now-sdk --help para obter informações sobre os comandos e opções globais disponíveis. Para obter informações adicionais sobre um comando e seus parâmetros, insira o comando e --help ou -h. Por exemplo, now-sdk auth --help. Para obter mais informações sobre a CLI, consulte ServiceNow SDK CLI.

    Procedimento

    1. Abra uma ferramenta de linha de comando no seu sistema.
    2. Especifique a instância para autenticação com o comando auth. 
      now-sdk auth save <alias> --type oauth

      Por exemplo:
      now-sdk auth save devuser1 --type oauth --default true
    3. No prompt, insira o URL da instância de destino.
      O ServiceNow SDK abre um navegador da Web para autenticar com a instância.
    4. Navegue até a página da Web que é aberta e faça login na instância se você não estiver conectado no momento.
    5. Selecione Aceitar para permitir que ServiceNow SDK se conecte à instância.
      A página é atualizada e inclui um código de autenticação.
    6. Selecione Copiar para copiar o código de autenticação fornecido.
    7. Na ferramenta de linha de comando do seu sistema, cole o código de autenticação.

    Resultado

    O alias e as credenciais são armazenados no conjunto de chaves do dispositivo ou no gerenciador de credenciais do seu sistema. O alias pode ser usado para autenticação com os comandos create, convert, fetche deploy.

    O que Fazer Depois

    Crie uma aplicação com escopo ou converta uma aplicação existente para uso com o ServiceNow SDK. Para obter mais informações, consulte Criar uma aplicação com ServiceNow SDK ou .