Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleSign in or create a developer account and open your ServiceNow instance

Login or signup for a ServiceNow developer account: https://developer.servicenow.com/dev.do.

Once logged in:

  1. Make sure that your user account has the IT Admin Role role is set to Admin, which is required to access instance configurations. If not, go to your ServiceNow Account > View Profile and change your Role to IT you can select Change User Role to change it to Admin.

  2. Click Start Building to access your instance and begin configuring your application.

Screen Shot 2024-04-04 at 12.35.11 PM.pngImage RemovedScreen Shot 2024-04-05 at 10.16.46 AM.pngImage Added

Note the Instance ID in the URL of your ServiceNow instance:

For example - https://dev252204.service-now.com/

Expand
titleEnsure your application has the necessary plugins enabled - OAuth2.0 and REST API Auth Scope
  1. Go to Admin > Application Manager

Screen Shot 2024-04-02 at 4.36.12 PM.png
  1. Search for the following plugins to verify they are installed and enabled:

    1. OAuth 2.0

    2. REST API Auth Scope

Screen Shot 2024-04-02 at 4.40.48 PM.pngScreen Shot 2024-04-02 at 4.40.29 PM.png
Expand
titleCreate a an ssh key pair and upload the public key certificate file to your ServiceNow instance to be used during authenticating requests

ServiceNow uses OAuth2.0 JWT API endpoint to authenticate external requests. Therefore we need to upload a public key to ServiceNow so it can verify the integrity of JWT tokens signed by clients (ie. Iguana X), ensuring secure authentication of external requests.

  1. Use OpenSSL command line to generate a key pair. You can use the following sample terminal commands:

Code Block
openssl genrsa -out private.pem 1024
openssl req -new -x509 -key private.pem -out public.cer -days 365
  1. Upload the public key to the X.509 Certificates table. You’ll use the private key in Iguana later.

    1. Use the explorer in the All tab to navigate to System Definition > Certifications.

    2. Click New, fill out the required information and paste your public key.

Screen Shot 2024-04-04 at 12.59.33 PM.pngScreen Shot 2024-04-04 at 1.16.22 PM.png

...

Expand
titleCreate an application endpoint (OAuth JWT API endpoint)
  1. Navigate to System OAuth > Application Registry, click New.

  2. Choose Create an OAuth JWT API endpoint for external clients and fill out the required details:

    1. Name: the name of the application endpoint (ex. IguanaX)

    2. OAuth Application User: a non-admin user account used to authenticate the connection. A new user can be created if necessary. (If this field is missing you can add it by right clicking the top grey bar > Configure > Form Design)

    3. Auth Scope: the scope of access that external clients connecting to this endpoint will have. Click Insert a new row, add useraccount and ticket_create, the scope we previously created.

Screen Shot 2024-04-04 at 1.46.47 PM.pngImage RemovedScreen Shot 2024-04-05 at 10.11.47 AM.pngImage Added
  1. Click Submit and then click on the newly created application. At the bottom of the page, click New to create a Jwt Verifier Map. For sys certificate, select the public key file you previously uploaded.

Screen Shot 2024-04-04 at 1.49.57 PM.png

...