ServiceNow ITOM connector and actionedit

The ServiceNow ITOM connector uses the event API to create ServiceNow events. You can use the connector for rule actions.

Create connectors in Kibanaedit

You can create connectors in Stack Management > Connectors or as needed when you’re creating a rule. You must choose whether to use OAuth for authentication.

ServiceNow ITOM connector using basic auth
ServiceNow ITOM connector using OAuth
Connector configurationedit

ServiceNow ITOM connectors have the following configuration properties:

Client ID
The client identifier assigned to your OAuth application.
Client secret
The client secret assigned to your OAuth application.
JWT verifier key ID
The key identifier assigned to the JWT verifier map of your OAuth application.
The password for HTTP basic authentication.
Private key
The RSA private key that you created for use in ServiceNow.
Private key password
The password for the RSA private key. This value is required when you set a password for your private key.
ServiceNow instance URL
The full URL for the ServiceNow instance.
Use OAuth authentication
By default, basic authentication is used instead of open authorization (OAuth).
User identifier
The identifier to use for OAuth type authentication. This identifier should be the user field you selected when you created an OAuth JWT API endpoint for external clients in your ServiceNow instance. For example, if the selected user field is Email, the user identifier should be the user’s email address.
The username for HTTP basic authentication.

Test connectorsedit

You can test connectors with the run connector API or as you’re creating or editing the connector in Kibana. For example:

ServiceNow ITOM params test

ServiceNow ITOM actions have the following configuration properties.

The details about the event.
Message key
All actions sharing this key are associated with the same ServiceNow alert. The default value is {{}}:{{}}.
Metric name
The name of the metric.
The host that the event was triggered for.
The name of the resource.
The severity of the event.
The name of the event source type.
Source instance
A specific instance of the source.
The type of event.

Refer to ServiceNow documentation for more information about the properties.

Connector networking configurationedit

Use the Action configuration settings to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use xpack.actions.customHostSettings to set per-host configurations.

Configure ServiceNow ITOMedit

ServiceNow offers free Personal Developer Instances, which you can use to test incidents.

Create a ServiceNow integration useredit

To ensure authenticated communication between Elastic and ServiceNow, create a ServiceNow integration user and assign it the appropriate roles.

  1. In your ServiceNow instance, go to System Security → Users and Groups → Users.
  2. Click New.
  3. Complete the form, then right-click on the menu bar and click Save.
  4. Go to the Roles tab and click Edit.
  5. Assign the integration user the following roles:

    • personalize_choices: Allows the user to retrieve Choice element options, such as Severity.
    • evt_mgmt_integration: Enables integration with external event sources by allowing the user to create events.
  6. Click Save.
Create an RSA keypair and add an X.509 Certificateedit

This step is required to use OAuth for authentication between Elastic and ServiceNow.

Create an RSA keypair:

  1. Use OpenSSL to generate an RSA private key:

    openssl genrsa -out example-private-key.pem 3072
    openssl genrsa -passout pass:foobar -out example-private-key-with-password.pem 3072 

    Use the passout option to set a password on your private key. This is optional but remember your password if you set one.

  2. Use OpenSSL to generate the matching public key:

    openssl req -new -x509 -key example-private-key.pem -out example-sn-cert.pem -days 360

Add an X.509 certificate to ServiceNow:

  1. In your ServiceNow instance, go to Certificates and select New.
  2. Configure the certificate as follows:

    • Name: Name the certificate.
    • PEM Certificate: Copy the generated public key into this text field.
    Shows new certificate form in ServiceNow
  3. Click Submit to create the certificate.
Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Mapedit

This step is required to use OAuth for authentication between Elastic and ServiceNow.

  1. In your ServiceNow instance, go to Application Registry and select New.
  2. Select Create an OAuth JWT API endpoint for external clients from the list of options.

    Shows application type selection
  3. Configure the application as follows:

    • Name: Name the application.
    • User field: Select the field to use as the user identifier.
    Shows new application form in ServiceNow

    Remember the selected user field. You will use this as the User Identifier Value when creating the connector. For example, if you selected Email for User field, you will use the user’s email for the User Identifier Value.

  4. Click Submit to create the application. You will be redirected to the list of applications.
  5. Select the application you just created.
  6. Find the Jwt Verifier Maps tab and click New.
  7. Configure the new record as follows:

    • Name: Name the JWT Verifier Map.
    • Sys certificate: Click the search icon and select the name of the certificate created in the previous step.
    Shows new JWT Verifier Map form in ServiceNow
  8. Click Submit to create the verifier map.
  9. Note the Client ID, Client Secret and JWT Key ID. You will need these values to create your ServiceNow connector.

    Shows where to find OAuth values in ServiceNow