Authenticate to a ServiceNow instance using OAuth 2.0 with the ServiceNow SDK

  • Freigeben Version: Australia
  • Aktualisiert 12. März 2026
  • 2 Minuten Lesedauer

    • Use OAuth 2.0 authentication to connect to a ServiceNow instance with the ServiceNow SDK.

    Vorbereitungen

    To use OAuth 2.0 authentication, your instance must have ServiceNow IDE (version 1.1 or later) installed or have the required XML configuration imported. By default, instances on the Australia release include ServiceNow IDE version 1.1.4 and support using OAuth 2.0 authentication with the ServiceNow SDK. For more information, see Configure a ServiceNow instance for OAuth 2.0 authentication with the ServiceNow SDK.

    An administrator must install the ServiceNow IDE (version 1.1 or later) on the instance or configure the instance to support using OAuth 2.0 with the ServiceNow SDK. For more information, see Install or update the ServiceNow IDE or Configure a ServiceNow instance for OAuth 2.0 authentication with the ServiceNow SDK.

    The default System Administrator (admin) user must configure the instance to support using OAuth 2.0 with the ServiceNow SDK. For more information, see Configure a ServiceNow instance for OAuth 2.0 authentication with the ServiceNow SDK.

    Role required: admin

    Warum und wann dieser Vorgang ausgeführt wird

    This procedure uses the ServiceNow SDK command-line interface (CLI). From a command-line tool, enter now-sdk --help to get information about the available commands and global options. To get additional information about a command and its parameters, enter the command and --help or -h. For example, now-sdk auth --help. For more information about the CLI, see ServiceNow SDK CLI.

    Prozedur

    1. Open a command-line tool on your system.
    2. Create a local directory for your application.
    3. In Visual Studio Code, open the directory.
    4. From the application directory, open an integrated Terminal window.
    5. Open a command-line tool on your system.
    6. Specify the instance to authenticate to with the auth command.Specify an alias and the authentication method to use with the auth save command. 
      npx @servicenow/sdk auth --add <instance>
      now-sdk auth save <alias> --type oauth

      To set this alias as the default alias, add the --default or -d parameter to your command.

      For example:
      npx @servicenow/sdk auth --add https://myinstance.service-now.com
      now-sdk auth save devuser1 --type oauth --default true
      Hinweis:
      Using the npx command installs the ServiceNow SDK in your application directory instead of globally.
    7. Respond to the following series of prompts.
      Prompt Response
      Type of authentication to use Select oauth.
      Alias for these credentials Enter an alias for your credentials and the instance.

      The alias can be used for authentication with the init, transform, dependencies, and install commands.
      The ServiceNow SDK opens a web browser to authenticate with the instance.
    8. At the prompt, enter the target instance URL.
      The ServiceNow SDK opens a web browser to authenticate with instance.
    9. Navigate to the web page that opens and log in to the instance if you aren't currently logged in.
    10. Select Accept to allow the ServiceNow SDK to connect to the instance.
      The page refreshes and includes an authentication code.
    11. Select Copy to copy the authentication code provided.
    12. In the command line, paste the authentication code.

    Ergebnisse

    The alias and credentials are stored in the device keychain or credential manager on your system and are set as the default credentials.

    Nächste Maßnahme

    Add an application to your local system with the ServiceNow SDK. For more information, see Adding applications with the ServiceNow SDK.