mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
[DOCS] Edits OAuth instructions in ServiceNow connector docs (#134970)
This commit is contained in:
Lisa Cawley
GitHub
parent
051dfe77f2
commit
c6768782f3
4 changed files with 120 additions and 248 deletions
|
|
@ -1,24 +1,25 @@
|
|||
[role="xpack"]
|
||||
[[servicenow-itom-action-type]]
|
||||
=== ServiceNow ITOM connector and action
|
||||
== {sn-itom} connector and action
|
||||
++++
|
||||
<titleabbrev>ServiceNow ITOM</titleabbrev>
|
||||
<titleabbrev>{sn-itom}</titleabbrev>
|
||||
++++
|
||||
|
||||
The {sn} ITOM connector uses the https://docs.servicenow.com/bundle/rome-it-operations-management/page/product/event-management/task/send-events-via-web-service.html[Event API] to create {sn} events.
|
||||
The {sn-itom} connector uses the
|
||||
https://docs.servicenow.com/bundle/rome-it-operations-management/page/product/event-management/task/send-events-via-web-service.html[event API]
|
||||
to create {sn} events.
|
||||
|
||||
[float]
|
||||
[[servicenow-itom-connector-prerequisites]]
|
||||
==== Prerequisites
|
||||
* Create a {sn} integration user and assign it the appropriate roles.
|
||||
=== Prerequisites
|
||||
|
||||
If you use open authorization (OAuth), you must also:
|
||||
|
||||
* Create an RSA keypair and add an X.509 Certificate.
|
||||
* Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map.
|
||||
. <<servicenow-itom-connector-prerequisites-integration-user,Create a {sn} integration user and assign it the appropriate roles.>>
|
||||
. If you use open authorization (OAuth), you must also:
|
||||
.. <<servicenow-itom-connector-prerequisites-rsa-key,Create an RSA keypair and add an X.509 Certificate>>.
|
||||
.. <<servicenow-itom-connector-prerequisites-endpoint,Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map>>.
|
||||
|
||||
[float]
|
||||
===== Create a {sn} integration user
|
||||
[[servicenow-itom-connector-prerequisites-integration-user]]
|
||||
==== Create a {sn} integration user
|
||||
|
||||
To ensure authenticated communication between Elastic and {sn}, create a {sn} integration user and assign it the appropriate roles.
|
||||
|
||||
|
|
@ -26,104 +27,32 @@ To ensure authenticated communication between Elastic and {sn}, create a {sn} in
|
|||
. Click *New*.
|
||||
. Complete the form, then right-click on the menu bar and click *Save*.
|
||||
. Go to the *Roles* tab and click *Edit*.
|
||||
. Assign the integration user the following roles:
|
||||
. 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.
|
||||
. Click *Save*.
|
||||
|
||||
[float]
|
||||
===== Create an RSA keypair and add an X.509 Certificate
|
||||
[[servicenow-itom-connector-prerequisites-rsa-key]]
|
||||
==== Create an RSA keypair and add an X.509 Certificate
|
||||
|
||||
This step is required to use OAuth for authentication between Elastic and {sn}.
|
||||
|
||||
*Create an RSA keypair:*
|
||||
include::servicenow.asciidoc[tag=servicenow-rsa-key]
|
||||
|
||||
. Use https://www.openssl.org/docs/man1.0.2/man1/genrsa.html[OpenSSL] to generate an RSA private key:
|
||||
+
|
||||
--
|
||||
[source,sh]
|
||||
----
|
||||
openssl genrsa -out example-private-key.pem 3072
|
||||
openssl genrsa -passout pass:foobar -out example-private-key-with-password.pem 3072 <1>
|
||||
----
|
||||
<1> Use the `passout` option to set a password on your private key. This is optional but remember your password if you set one.
|
||||
--
|
||||
|
||||
. Use https://www.openssl.org/docs/man1.0.2/man1/req.html[OpenSSL] to generate the matching public key:
|
||||
+
|
||||
--
|
||||
[source,sh]
|
||||
----
|
||||
openssl req -new -x509 -key example-private-key.pem -out example-sn-cert.pem -days 360
|
||||
----
|
||||
--
|
||||
|
||||
*Add an X.509 Certificate to ServiceNow:*
|
||||
|
||||
. In your {sn} instance, go to *Certificates* and select *New*.
|
||||
. Configure the certificate as follows:
|
||||
+
|
||||
--
|
||||
* *Name*: Name the certificate.
|
||||
* *PEM Certificate*: Copy the generated public key into this text field.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-new-certificate.png[Shows new certificate form in ServiceNow]
|
||||
--
|
||||
|
||||
. Click *Submit* to create the certificate.
|
||||
include::servicenow.asciidoc[tag=servicenow-certificate]
|
||||
|
||||
[float]
|
||||
===== Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map
|
||||
[[servicenow-itom-connector-prerequisites-endpoint]]
|
||||
==== Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map
|
||||
|
||||
This step is required to use OAuth for authentication between Elastic and {sn}.
|
||||
|
||||
. In your {sn} instance, go to *Application Registry* and select *New*.
|
||||
. Select *Create an OAuth JWT API endpoint for external clients* from the list of options.
|
||||
+
|
||||
--
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-jwt-endpoint.png[Shows application type selection]
|
||||
--
|
||||
|
||||
. Configure the application as follows:
|
||||
+
|
||||
--
|
||||
* *Name*: Name the application.
|
||||
* *User field*: Select the field to use as the user identifier.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-new-application.png[Shows new application form in ServiceNow]
|
||||
|
||||
IMPORTANT: 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*.
|
||||
--
|
||||
|
||||
. Click *Submit* to create the application. You will be redirected to the list of applications.
|
||||
. Select the application you just created.
|
||||
. Find the *Jwt Verifier Maps* tab and click *New*.
|
||||
. 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.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-new-jwt-verifier-map.png[Shows new JWT Verifier Map form in ServiceNow]
|
||||
--
|
||||
|
||||
. Click *Submit* to create the application.
|
||||
. Note the *Client ID*, *Client Secret* and *JWT Key ID*. You will need these values to create your {sn} connector.
|
||||
+
|
||||
--
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-oauth-values.png[Shows where to find OAuth values in ServiceNow]
|
||||
--
|
||||
include::servicenow.asciidoc[tag=servicenow-endpoint]
|
||||
|
||||
[float]
|
||||
[[servicenow-itom-connector-configuration]]
|
||||
==== Connector configuration
|
||||
=== Connector configuration
|
||||
|
||||
{sn} ITOM connectors have the following configuration properties.
|
||||
{sn-itom} connectors have the following configuration properties.
|
||||
|
||||
Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** connector listing, and in the connector list when configuring an action.
|
||||
Is OAuth:: The type of authentication to use.
|
||||
|
|
@ -139,13 +68,13 @@ Private Key Password:: The password for the RSA private key generated during set
|
|||
|
||||
[float]
|
||||
[[servicenow-itom-connector-networking-configuration]]
|
||||
==== Connector networking configuration
|
||||
=== Connector networking configuration
|
||||
|
||||
Use the <<action-settings, 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.
|
||||
|
||||
[float]
|
||||
[[Preconfigured-servicenow-itom-configuration]]
|
||||
==== Preconfigured connector type
|
||||
=== Preconfigured connector type
|
||||
|
||||
Connector using Basic Authentication
|
||||
[source,text]
|
||||
|
|
@ -196,26 +125,26 @@ Secrets defines sensitive information for the connector type.
|
|||
|
||||
[float]
|
||||
[[define-servicenow-itom-ui]]
|
||||
==== Define connector in Stack Management
|
||||
=== Define connector in Stack Management
|
||||
|
||||
Define {sn} ITOM connector properties. Choose whether to use OAuth for authentication.
|
||||
Define {sn-itom} connector properties. Choose whether to use OAuth for authentication.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-itom-connector-basic.png[ServiceNow ITOM connector using basic auth]
|
||||
image::management/connectors/images/servicenow-itom-connector-basic.png[{sn-itom} connector using basic auth]
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-itom-connector-oauth.png[ServiceNow ITOM connector using OAuth]
|
||||
image::management/connectors/images/servicenow-itom-connector-oauth.png[{sn-itom} connector using OAuth]
|
||||
|
||||
Test {sn} ITOM action parameters.
|
||||
Test {sn-itom} action parameters.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-itom-params-test.png[ServiceNow ITOM params test]
|
||||
image::management/connectors/images/servicenow-itom-params-test.png[{sn-itom} params test]
|
||||
|
||||
[float]
|
||||
[[servicenow-itom-action-configuration]]
|
||||
==== Action configuration
|
||||
=== Action configuration
|
||||
|
||||
{sn} ITOM actions have the following configuration properties.
|
||||
{sn-itom} actions have the following configuration properties.
|
||||
|
||||
Source:: The name of the event source type.
|
||||
Node:: The Host that the event was triggered for.
|
||||
|
|
@ -227,10 +156,10 @@ Message key:: All actions sharing this key will be associated with the same {sn
|
|||
Severity:: The severity of the event.
|
||||
Description:: The details about the event.
|
||||
|
||||
Refer to https://docs.servicenow.com/bundle/rome-it-operations-management/page/product/event-management/task/send-events-via-web-service.html[ServiceNow documentation] for more information about the properties.
|
||||
Refer to https://docs.servicenow.com/bundle/rome-it-operations-management/page/product/event-management/task/send-events-via-web-service.html[{sn} documentation] for more information about the properties.
|
||||
|
||||
[float]
|
||||
[[configuring-servicenow-itom]]
|
||||
==== Configure {sn} ITOM
|
||||
=== Configure {sn-itom}
|
||||
|
||||
{sn} offers free https://developer.servicenow.com/dev.do#!/guides/madrid/now-platform/pdi-guide/obtaining-a-pdi[Personal Developer Instances], which you can use to test incidents.
|
||||
|
|
|
|||
|
|
@ -1,28 +1,28 @@
|
|||
[role="xpack"]
|
||||
[[servicenow-sir-action-type]]
|
||||
=== ServiceNow SecOps connector and action
|
||||
== {sn-sir} connector and action
|
||||
++++
|
||||
<titleabbrev>ServiceNow SecOps</titleabbrev>
|
||||
<titleabbrev>{sn-sir}</titleabbrev>
|
||||
++++
|
||||
|
||||
The {sn} SecOps connector uses the https://developer.servicenow.com/dev.do#!/reference/api/sandiego/rest/c_ImportSetAPI[Import Set API] to create {sn} security incidents.
|
||||
The {sn-sir} connector uses the
|
||||
https://developer.servicenow.com/dev.do#!/reference/api/sandiego/rest/c_ImportSetAPI[import set API]
|
||||
to create {sn} security incidents.
|
||||
|
||||
[float]
|
||||
[[servicenow-sir-connector-prerequisites]]
|
||||
==== Prerequisites
|
||||
After upgrading from {stack} version 7.15.0 or earlier to version 7.16.0 or later, you must complete the following within your {sn} instance before creating a new {sn} SecOps connector or <<servicenow-sir-connector-update, updating an existing one>>:
|
||||
=== Prerequisites
|
||||
After upgrading from {stack} version 7.15.0 or earlier to version 7.16.0 or later, you must complete the following within your {sn} instance before creating a new {sn-sir} connector or <<servicenow-sir-connector-update, updating an existing one>>:
|
||||
|
||||
* Install https://store.servicenow.com/sn_appstore_store.do#!/store/application/2f0746801baeb01019ae54e4604bcb0f[Elastic for Security Operations (SecOps)] from the {sn} Store.
|
||||
* Create a {sn} integration user and assign it the appropriate roles.
|
||||
* Create a Cross-Origin Resource Sharing (CORS) rule.
|
||||
|
||||
If you use open authorization (OAuth), you must also:
|
||||
|
||||
* Create an RSA keypair and add an X.509 Certificate.
|
||||
* Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map.
|
||||
. Install https://store.servicenow.com/sn_appstore_store.do#!/store/application/2f0746801baeb01019ae54e4604bcb0f[Elastic for Security Operations (SecOps)] from the {sn} Store.
|
||||
. <<servicenow-sir-connector-prerequisites-integration-user,Create a {sn} integration user and assign it the appropriate roles>>.
|
||||
. <<servicenow-sir-connector-prerequisites-cors-rule,Create a Cross-Origin Resource Sharing (CORS) rule>>.
|
||||
. If you use open authorization (OAuth), you must also:
|
||||
.. <<servicenow-sir-connector-prerequisites-rsa-key,Create an RSA keypair and add an X.509 Certificate>>.
|
||||
.. <<servicenow-sir-connector-prerequisites-endpoint,Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map>>.
|
||||
|
||||
[float]
|
||||
===== Create a {sn} integration user
|
||||
[[servicenow-sir-connector-prerequisites-integration-user]]
|
||||
==== Create a {sn} integration user
|
||||
|
||||
To ensure authenticated communication between Elastic and {sn}, create a {sn} integration user and assign it the appropriate roles.
|
||||
|
||||
|
|
@ -39,7 +39,8 @@ To ensure authenticated communication between Elastic and {sn}, create a {sn} in
|
|||
. Click *Save*.
|
||||
|
||||
[float]
|
||||
===== Create a CORS rule
|
||||
[[servicenow-sir-connector-prerequisites-cors-rule]]
|
||||
==== Create a CORS rule
|
||||
|
||||
A CORS rule is required for communication between Elastic and {sn}. To create a CORS rule:
|
||||
|
||||
|
|
@ -53,98 +54,26 @@ A CORS rule is required for communication between Elastic and {sn}. To create a
|
|||
. Click *Submit* to create the rule.
|
||||
|
||||
[float]
|
||||
===== Create an RSA keypair and add an X.509 Certificate
|
||||
[[servicenow-sir-connector-prerequisites-rsa-key]]
|
||||
==== Create an RSA keypair and add an X.509 Certificate
|
||||
|
||||
This step is required to use OAuth for authentication between Elastic and {sn}.
|
||||
|
||||
*Create an RSA keypair:*
|
||||
include::servicenow.asciidoc[tag=servicenow-rsa-key]
|
||||
|
||||
. Use https://www.openssl.org/docs/man1.0.2/man1/genrsa.html[OpenSSL] to generate an RSA private key:
|
||||
+
|
||||
--
|
||||
[source,sh]
|
||||
----
|
||||
openssl genrsa -out example-private-key.pem 3072
|
||||
openssl genrsa -passout pass:foobar -out example-private-key-with-password.pem 3072 <1>
|
||||
----
|
||||
<1> Use the `passout` option to set a password on your private key. This is optional but remember your password if you set one.
|
||||
--
|
||||
|
||||
. Use https://www.openssl.org/docs/man1.0.2/man1/req.html[OpenSSL] to generate the matching public key:
|
||||
+
|
||||
--
|
||||
[source,sh]
|
||||
----
|
||||
openssl req -new -x509 -key example-private-key.pem -out example-sn-cert.pem -days 360
|
||||
----
|
||||
--
|
||||
|
||||
*Add an X.509 Certificate to ServiceNow:*
|
||||
|
||||
. In your {sn} instance, go to *Certificates* and select *New*.
|
||||
. Configure the certificate as follows:
|
||||
+
|
||||
--
|
||||
* *Name*: Name the certificate.
|
||||
* *PEM Certificate*: Copy the generated public key into this text field.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-new-certificate.png[Shows new certificate form in ServiceNow]
|
||||
--
|
||||
|
||||
. Click *Submit* to create the certificate.
|
||||
include::servicenow.asciidoc[tag=servicenow-certificate]
|
||||
|
||||
[float]
|
||||
===== Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map
|
||||
[[servicenow-sir-connector-prerequisites-endpoint]]
|
||||
==== Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map
|
||||
|
||||
This step is required to use OAuth for authentication between Elastic and {sn}.
|
||||
|
||||
. In your {sn} instance, go to *Application Registry* and select *New*.
|
||||
. Select *Create an OAuth JWT API endpoint for external clients* from the list of options.
|
||||
+
|
||||
--
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-jwt-endpoint.png[Shows application type selection]
|
||||
--
|
||||
|
||||
. Configure the application as follows:
|
||||
+
|
||||
--
|
||||
* *Name*: Name the application.
|
||||
* *User field*: Select the field to use as the user identifier.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-new-application.png[Shows new application form in ServiceNow]
|
||||
|
||||
IMPORTANT: 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*.
|
||||
--
|
||||
|
||||
. Click *Submit* to create the application. You will be redirected to the list of applications.
|
||||
. Select the application you just created.
|
||||
. Find the *Jwt Verifier Maps* tab and click *New*.
|
||||
. 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.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-new-jwt-verifier-map.png[Shows new JWT Verifier Map form in ServiceNow]
|
||||
--
|
||||
|
||||
. Click *Submit* to create the verifier map.
|
||||
. Note the *Client ID*, *Client Secret* and *JWT Key ID*. You will need these values to create your {sn} connector.
|
||||
+
|
||||
--
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-oauth-values.png[Shows where to find OAuth values in ServiceNow]
|
||||
--
|
||||
include::servicenow.asciidoc[tag=servicenow-endpoint]
|
||||
|
||||
[float]
|
||||
[[servicenow-sir-connector-update]]
|
||||
==== Update a deprecated {sn} SecOps connector
|
||||
=== Update a deprecated {sn-sir} connector
|
||||
|
||||
{sn} SecOps connectors created in {stack} version 7.15.0 or earlier are marked as deprecated after you upgrade to version 7.16.0 or later. Deprecated connectors have a yellow icon after their name and display a warning message when selected.
|
||||
{sn-sir} connectors created in {stack} version 7.15.0 or earlier are marked as deprecated after you upgrade to version 7.16.0 or later. Deprecated connectors have a yellow icon after their name and display a warning message when selected.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-sir-update-connector.png[Shows deprecated ServiceNow connectors]
|
||||
|
|
@ -164,9 +93,9 @@ To update a deprecated connector:
|
|||
|
||||
[float]
|
||||
[[servicenow-sir-connector-configuration]]
|
||||
==== Connector configuration
|
||||
=== Connector configuration
|
||||
|
||||
{sn} SecOps connectors have the following configuration properties.
|
||||
{sn-sir} connectors have the following configuration properties.
|
||||
|
||||
Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action.
|
||||
Is OAuth:: The type of authentication to use.
|
||||
|
|
@ -182,13 +111,13 @@ Private Key Password:: The password for the RSA private key generated during set
|
|||
|
||||
[float]
|
||||
[[servicenow-sir-connector-networking-configuration]]
|
||||
==== Connector networking configuration
|
||||
=== Connector networking configuration
|
||||
|
||||
Use the <<action-settings, 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.
|
||||
|
||||
[float]
|
||||
[[Preconfigured-servicenow-sir-configuration]]
|
||||
==== Preconfigured connector type
|
||||
=== Preconfigured connector type
|
||||
|
||||
Connector using Basic Authentication
|
||||
[source,text]
|
||||
|
|
@ -244,26 +173,26 @@ Secrets defines sensitive information for the connector type.
|
|||
|
||||
[float]
|
||||
[[define-servicenow-sir-ui]]
|
||||
==== Define connector in Stack Management
|
||||
=== Define connector in Stack Management
|
||||
|
||||
Define {sn} SecOps connector properties. Choose whether to use OAuth for authentication.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-sir-connector-basic.png[ServiceNow SecOps connector using basic auth]
|
||||
image::management/connectors/images/servicenow-sir-connector-basic.png[{sn-sir} connector using basic auth]
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-sir-connector-oauth.png[ServiceNow SecOps connector using OAuth]
|
||||
image::management/connectors/images/servicenow-sir-connector-oauth.png[{sn-sir} connector using OAuth]
|
||||
|
||||
Test {sn} SecOps action parameters.
|
||||
Test {sn-sir} action parameters.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-sir-params-test.png[ServiceNow SecOps params test]
|
||||
image::management/connectors/images/servicenow-sir-params-test.png[{sn-sir} params test]
|
||||
|
||||
[float]
|
||||
[[servicenow-sir-action-configuration]]
|
||||
==== Action configuration
|
||||
=== Action configuration
|
||||
|
||||
ServiceNow SecOps actions have the following configuration properties.
|
||||
{sn-sir} actions have the following configuration properties.
|
||||
|
||||
Short description:: A short description for the incident, used for searching the contents of the knowledge base.
|
||||
Priority:: The priority of the incident.
|
||||
|
|
@ -279,6 +208,6 @@ Additional comments:: Additional information for the client, such as how to tro
|
|||
|
||||
[float]
|
||||
[[configuring-servicenow-sir]]
|
||||
==== Configure {sn} SecOps
|
||||
=== Configure {sn-sir}
|
||||
|
||||
{sn} offers free https://developer.servicenow.com/dev.do#!/guides/madrid/now-platform/pdi-guide/obtaining-a-pdi[Personal Developer Instances], which you can use to test incidents.
|
||||
|
|
|
|||
|
|
@ -1,28 +1,34 @@
|
|||
[role="xpack"]
|
||||
[[servicenow-action-type]]
|
||||
=== ServiceNow ITSM connector and action
|
||||
== {sn-itsm} connector and action
|
||||
++++
|
||||
<titleabbrev>ServiceNow ITSM</titleabbrev>
|
||||
<titleabbrev>{sn-itsm}</titleabbrev>
|
||||
++++
|
||||
|
||||
The {sn} ITSM connector uses the https://developer.servicenow.com/dev.do#!/reference/api/sandiego/rest/c_ImportSetAPI[Import Set API] to create {sn} incidents.
|
||||
The {sn-itsm} connector uses the
|
||||
https://developer.servicenow.com/dev.do#!/reference/api/sandiego/rest/c_ImportSetAPI[import set API]
|
||||
to create {sn} incidents.
|
||||
|
||||
[float]
|
||||
[[servicenow-itsm-connector-prerequisites]]
|
||||
==== Prerequisites
|
||||
After upgrading from {stack} version 7.15.0 or earlier to version 7.16.0 or later, you must complete the following within your {sn} instance before creating a new {sn} ITSM connector or <<servicenow-itsm-connector-update, updating an existing one>>:
|
||||
=== Prerequisites
|
||||
|
||||
* Install https://store.servicenow.com/sn_appstore_store.do#!/store/application/7148dbc91bf1f450ced060a7234bcb88[Elastic for ITSM] from the {sn} Store.
|
||||
* Create a {sn} integration user and assign it the appropriate roles.
|
||||
* Create a Cross-Origin Resource Sharing (CORS) rule.
|
||||
After upgrading from {stack} version 7.15.0 or earlier to version 7.16.0 or
|
||||
later, you must complete the following steps within your {sn} instance before
|
||||
creating a new {sn-itsm} connector or
|
||||
<<servicenow-itsm-connector-update,updating an existing one>>:
|
||||
|
||||
If you use open authorization (OAuth), you must also:
|
||||
|
||||
* Create an RSA keypair and add an X.509 Certificate.
|
||||
* Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map.
|
||||
. Install
|
||||
https://store.servicenow.com/sn_appstore_store.do#!/store/application/7148dbc91bf1f450ced060a7234bcb88[Elastic for ITSM]
|
||||
from the {sn} Store.
|
||||
. <<servicenow-itsm-connector-prerequisites-integration-user,Create a {sn} integration user and assign it the appropriate roles>>.
|
||||
. <<servicenow-itsm-connector-prerequisites-cors-rule,Create a Cross-Origin Resource Sharing (CORS) rule>>.
|
||||
. If you use open authorization (OAuth), you must also:
|
||||
.. <<servicenow-itsm-connector-prerequisites-rsa-key,Create an RSA keypair and add an X.509 Certificate>>.
|
||||
.. <<servicenow-itsm-connector-prerequisites-endpoint,Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map>>.
|
||||
|
||||
[float]
|
||||
===== Create a {sn} integration user
|
||||
[[servicenow-itsm-connector-prerequisites-integration-user]]
|
||||
==== Create a {sn} integration user
|
||||
|
||||
To ensure authenticated communication between Elastic and {sn}, create a {sn} integration user and assign it the appropriate roles.
|
||||
|
||||
|
|
@ -38,7 +44,8 @@ To ensure authenticated communication between Elastic and {sn}, create a {sn} in
|
|||
. Click *Save*.
|
||||
|
||||
[float]
|
||||
===== Create a CORS rule
|
||||
[[servicenow-itsm-connector-prerequisites-cors-rule]]
|
||||
==== Create a CORS rule
|
||||
|
||||
A CORS rule is required for communication between Elastic and {sn}. To create a CORS rule:
|
||||
|
||||
|
|
@ -52,10 +59,12 @@ A CORS rule is required for communication between Elastic and {sn}. To create a
|
|||
. Click *Submit* to create the rule.
|
||||
|
||||
[float]
|
||||
===== Create an RSA keypair and add an X.509 Certificate
|
||||
[[servicenow-itsm-connector-prerequisites-rsa-key]]
|
||||
==== Create an RSA keypair and add an X.509 certificate
|
||||
|
||||
This step is required to use OAuth for authentication between Elastic and {sn}.
|
||||
|
||||
// tag::servicenow-rsa-key[]
|
||||
*Create an RSA keypair:*
|
||||
|
||||
. Use https://www.openssl.org/docs/man1.0.2/man1/genrsa.html[OpenSSL] to generate an RSA private key:
|
||||
|
|
@ -77,8 +86,9 @@ openssl genrsa -passout pass:foobar -out example-private-key-with-password.pem 3
|
|||
openssl req -new -x509 -key example-private-key.pem -out example-sn-cert.pem -days 360
|
||||
----
|
||||
--
|
||||
|
||||
*Add an X.509 Certificate to ServiceNow:*
|
||||
// end::servicenow-rsa-key[]
|
||||
// tag::servicenow-certificate[]
|
||||
*Add an X.509 certificate to ServiceNow:*
|
||||
|
||||
. In your {sn} instance, go to *Certificates* and select *New*.
|
||||
. Configure the certificate as follows:
|
||||
|
|
@ -92,10 +102,13 @@ image::management/connectors/images/servicenow-new-certificate.png[Shows new cer
|
|||
--
|
||||
|
||||
. Click *Submit* to create the certificate.
|
||||
// end::servicenow-certificate[]
|
||||
|
||||
[float]
|
||||
===== Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map
|
||||
[[servicenow-itsm-connector-prerequisites-endpoint]]
|
||||
==== Create an OAuth JWT API endpoint for external clients with a JWT Verifiers Map
|
||||
|
||||
// tag::servicenow-endpoint[]
|
||||
This step is required to use OAuth for authentication between Elastic and {sn}.
|
||||
|
||||
. In your {sn} instance, go to *Application Registry* and select *New*.
|
||||
|
|
@ -138,12 +151,13 @@ image::management/connectors/images/servicenow-new-jwt-verifier-map.png[Shows ne
|
|||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-oauth-values.png[Shows where to find OAuth values in ServiceNow]
|
||||
--
|
||||
// end::servicenow-endpoint[]
|
||||
|
||||
[float]
|
||||
[[servicenow-itsm-connector-update]]
|
||||
==== Update a deprecated {sn} ITSM connector
|
||||
=== Update a deprecated {sn-itsm} connector
|
||||
|
||||
{sn} ITSM connectors created in {stack} version 7.15.0 or earlier are marked as deprecated after you upgrade to version 7.16.0 or later. Deprecated connectors have a yellow icon after their name and display a warning message when selected.
|
||||
{sn-itsm} connectors created in {stack} version 7.15.0 or earlier are marked as deprecated after you upgrade to version 7.16.0 or later. Deprecated connectors have a yellow icon after their name and display a warning message when selected.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-sir-update-connector.png[Shows deprecated ServiceNow connectors]
|
||||
|
|
@ -163,9 +177,9 @@ To update a deprecated connector:
|
|||
|
||||
[float]
|
||||
[[servicenow-connector-configuration]]
|
||||
==== Connector configuration
|
||||
=== Connector configuration
|
||||
|
||||
{sn} ITSM connectors have the following configuration properties.
|
||||
{sn-itsm} connectors have the following configuration properties.
|
||||
|
||||
Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action.
|
||||
Is OAuth:: The type of authentication to use.
|
||||
|
|
@ -181,13 +195,13 @@ Private Key Password:: The password for the RSA private key generated during set
|
|||
|
||||
[float]
|
||||
[[servicenow-connector-networking-configuration]]
|
||||
==== Connector networking configuration
|
||||
=== Connector networking configuration
|
||||
|
||||
Use the <<action-settings, 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.
|
||||
|
||||
[float]
|
||||
[[Preconfigured-servicenow-configuration]]
|
||||
==== Preconfigured connector type
|
||||
=== Preconfigured connector type
|
||||
|
||||
Connector using Basic Authentication
|
||||
[source,text]
|
||||
|
|
@ -243,9 +257,9 @@ Secrets defines sensitive information for the connector type.
|
|||
|
||||
[float]
|
||||
[[define-servicenow-ui]]
|
||||
==== Define connector in Stack Management
|
||||
=== Define connector in Stack Management
|
||||
|
||||
Define {sn} ITSM connector properties. Choose whether to use OAuth for authentication.
|
||||
Define {sn-itsm} connector properties. Choose whether to use OAuth for authentication.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-connector-basic.png[ServiceNow connector using basic auth]
|
||||
|
|
@ -253,16 +267,16 @@ image::management/connectors/images/servicenow-connector-basic.png[ServiceNow co
|
|||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-connector-oauth.png[ServiceNow connector using OAuth]
|
||||
|
||||
Test {sn} ITSM action parameters.
|
||||
Test {sn-itsm} action parameters.
|
||||
|
||||
[role="screenshot"]
|
||||
image::management/connectors/images/servicenow-params-test.png[ServiceNow params test]
|
||||
|
||||
[float]
|
||||
[[servicenow-action-configuration]]
|
||||
==== Action configuration
|
||||
=== Action configuration
|
||||
|
||||
{sn} ITSM actions have the following configuration properties.
|
||||
{sn-itsm} actions have the following configuration properties.
|
||||
|
||||
Urgency:: The extent to which the incident resolution can delay.
|
||||
Severity:: The severity of the incident.
|
||||
|
|
@ -280,6 +294,6 @@ Additional comments:: Additional information for the client, such as how to tro
|
|||
|
||||
[float]
|
||||
[[configuring-servicenow]]
|
||||
==== Configure {sn}
|
||||
=== Configure {sn}
|
||||
|
||||
{sn} offers free https://developer.servicenow.com/dev.do#!/guides/madrid/now-platform/pdi-guide/obtaining-a-pdi[Personal Developer Instances], which you can use to test incidents.
|
||||
|
|
|
|||
|
|
@ -5,9 +5,9 @@ include::action-types/jira.asciidoc[]
|
|||
include::action-types/teams.asciidoc[]
|
||||
include::action-types/pagerduty.asciidoc[]
|
||||
include::action-types/server-log.asciidoc[]
|
||||
include::action-types/servicenow.asciidoc[]
|
||||
include::action-types/servicenow-sir.asciidoc[]
|
||||
include::action-types/servicenow-itom.asciidoc[]
|
||||
include::action-types/servicenow.asciidoc[leveloffset=+1]
|
||||
include::action-types/servicenow-sir.asciidoc[leveloffset=+1]
|
||||
include::action-types/servicenow-itom.asciidoc[leveloffset=+1]
|
||||
include::action-types/swimlane.asciidoc[]
|
||||
include::action-types/slack.asciidoc[]
|
||||
include::action-types/webhook.asciidoc[]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue