mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
[DOCS] Move preconfigured ServiceNow connector details (#166202)
This commit is contained in:
Lisa Cawley
GitHub
parent
7550f9e0de
commit
0fc24f4181
5 changed files with 197 additions and 183 deletions
|
|
@ -3,6 +3,10 @@
|
|||
++++
|
||||
<titleabbrev>{sn-itom}</titleabbrev>
|
||||
++++
|
||||
:frontmatter-description: Add a connector that can create {sn} events.
|
||||
:frontmatter-tags-products: [kibana]
|
||||
:frontmatter-tags-content-type: [how-to]
|
||||
:frontmatter-tags-user-goals: [configure]
|
||||
|
||||
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]
|
||||
|
|
@ -79,62 +83,6 @@ JWT Key ID:: The key ID assigned to the JWT verifier map of your OAuth applicati
|
|||
Private Key:: The RSA private key generated during setup.
|
||||
Private Key Password:: The password for the RSA private key generated during setup, if set.
|
||||
|
||||
[float]
|
||||
[[preconfigured-servicenow-itom-configuration]]
|
||||
=== Create preconfigured connectors
|
||||
|
||||
If you are running {kib} on-prem, you can define connectors by
|
||||
adding `xpack.actions.preconfigured` settings to your `kibana.yml` file.
|
||||
For example:
|
||||
|
||||
Connector using Basic Authentication
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-servicenow-itom:
|
||||
name: preconfigured-servicenow-connector-type
|
||||
actionTypeId: .servicenow-itom
|
||||
config:
|
||||
apiUrl: https://example.service-now.com/
|
||||
secrets:
|
||||
username: testuser
|
||||
password: passwordkeystorevalue
|
||||
--
|
||||
|
||||
Connector using OAuth
|
||||
[source,text]
|
||||
--
|
||||
my-servicenow:
|
||||
name: preconfigured-oauth-servicenow-connector-type
|
||||
actionTypeId: .servicenow-itom
|
||||
config:
|
||||
apiUrl: https://example.service-now.com/
|
||||
usesTableApi: false
|
||||
isOAuth: true
|
||||
userIdentifierValue: testuser@email.com
|
||||
clientId: abcdefghijklmnopqrstuvwxyzabcdef
|
||||
jwtKeyId: fedcbazyxwvutsrqponmlkjihgfedcba
|
||||
secrets:
|
||||
clientSecret: secretsecret
|
||||
privateKey: -----BEGIN RSA PRIVATE KEY-----\nprivatekeyhere\n-----END RSA PRIVATE KEY-----
|
||||
--
|
||||
|
||||
Config defines information for the connector type.
|
||||
|
||||
`apiUrl`:: An address that corresponds to *URL*.
|
||||
`isOAuth`:: A boolean that corresponds to *Is OAuth* and indicates if the connector uses Basic Authentication or OAuth.
|
||||
`userIdentifierValue`:: A string that corresponds to *User Identifier*. Required if `isOAuth` is set to `true`.
|
||||
`clientId`:: A string that corresponds to *Client ID*, used for OAuth authentication. Required if `isOAuth` is set to `true`.
|
||||
`jwtKeyId`:: A string that corresponds to *JWT Key ID*, used for OAuth authentication. Required if `isOAuth` is set to `true`.
|
||||
|
||||
Secrets defines sensitive information for the connector type.
|
||||
|
||||
`username`:: A string that corresponds to *Username*. Required if `isOAuth` is set to `false`.
|
||||
`password`:: A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>. Required if `isOAuth` is set to `false`.
|
||||
`clientSecret`:: A string that corresponds to *Client Secret*. Required if `isOAuth` is set to `true`.
|
||||
`privateKey`:: A string that corresponds to *Private Key*. Required if `isOAuth` is set to `true`.
|
||||
`privateKeyPassword`:: A string that corresponds to *Private Key Password*.
|
||||
|
||||
[float]
|
||||
[[servicenow-itom-action-configuration]]
|
||||
=== Test connectors
|
||||
|
|
|
|||
|
|
@ -3,6 +3,10 @@
|
|||
++++
|
||||
<titleabbrev>{sn-sir}</titleabbrev>
|
||||
++++
|
||||
:frontmatter-description: Add a connector that can create {sn} security incidents.
|
||||
:frontmatter-tags-products: [kibana]
|
||||
:frontmatter-tags-content-type: [how-to]
|
||||
:frontmatter-tags-user-goals: [configure]
|
||||
|
||||
The {sn-sir} connector uses the
|
||||
https://developer.servicenow.com/dev.do#!/reference/api/sandiego/rest/c_ImportSetAPI[import set API]
|
||||
|
|
@ -122,68 +126,6 @@ JWT Key ID:: The key ID assigned to the JWT verifier map of your OAuth applicati
|
|||
Private Key:: The RSA private key generated during setup.
|
||||
Private Key Password:: The password for the RSA private key generated during setup, if set.
|
||||
|
||||
[float]
|
||||
[[preconfigured-servicenow-sir-configuration]]
|
||||
=== Create preconfigured connectors
|
||||
|
||||
If you are running {kib} on-prem, you can define connectors by
|
||||
adding `xpack.actions.preconfigured` settings to your `kibana.yml` file.
|
||||
For example:
|
||||
|
||||
Connector using Basic Authentication
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-servicenow-sir:
|
||||
name: preconfigured-servicenow-connector-type
|
||||
actionTypeId: .servicenow-sir
|
||||
config:
|
||||
apiUrl: https://example.service-now.com/
|
||||
usesTableApi: false
|
||||
secrets:
|
||||
username: testuser
|
||||
password: passwordkeystorevalue
|
||||
--
|
||||
|
||||
Connector using OAuth
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-servicenow:
|
||||
name: preconfigured-oauth-servicenow-connector-type
|
||||
actionTypeId: .servicenow-sir
|
||||
config:
|
||||
apiUrl: https://example.service-now.com/
|
||||
usesTableApi: false
|
||||
isOAuth: true
|
||||
userIdentifierValue: testuser@email.com
|
||||
clientId: abcdefghijklmnopqrstuvwxyzabcdef
|
||||
jwtKeyId: fedcbazyxwvutsrqponmlkjihgfedcba
|
||||
secrets:
|
||||
clientSecret: secretsecret
|
||||
privateKey: -----BEGIN RSA PRIVATE KEY-----\nprivatekeyhere\n-----END RSA PRIVATE KEY-----
|
||||
--
|
||||
|
||||
Config defines information for the connector type.
|
||||
|
||||
`apiUrl`:: An address that corresponds to *URL*.
|
||||
`usesTableApi`:: A boolean that indicates if the connector uses the Table API or the Import Set API.
|
||||
|
||||
NOTE: If `usesTableApi` is set to false, the Elastic application should be installed in {sn}.
|
||||
|
||||
`isOAuth`:: A boolean that corresponds to *Is OAuth* and indicates if the connector uses Basic Authentication or OAuth.
|
||||
`userIdentifierValue`:: A string that corresponds to *User Identifier*. Required if `isOAuth` is set to `true`.
|
||||
`clientId`:: A string that corresponds to *Client ID*, used for OAuth authentication. Required if `isOAuth` is set to `true`.
|
||||
`jwtKeyId`:: A string that corresponds to *JWT Key ID*, used for OAuth authentication. Required if `isOAuth` is set to `true`.
|
||||
|
||||
Secrets defines sensitive information for the connector type.
|
||||
|
||||
`username`:: A string that corresponds to *Username*. Required if `isOAuth` is set to `false`.
|
||||
`password`:: A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>. Required if `isOAuth` is set to `false`.
|
||||
`clientSecret`:: A string that corresponds to *Client Secret*. Required if `isOAuth` is set to `true`.
|
||||
`privateKey`:: A string that corresponds to *Private Key*. Required if `isOAuth` is set to `true`.
|
||||
`privateKeyPassword`:: A string that corresponds to *Private Key Password*.
|
||||
|
||||
[float]
|
||||
[[servicenow-sir-action-configuration]]
|
||||
=== Test connectors
|
||||
|
|
|
|||
|
|
@ -3,6 +3,10 @@
|
|||
++++
|
||||
<titleabbrev>{sn-itsm}</titleabbrev>
|
||||
++++
|
||||
:frontmatter-description: Add a connector that can create {sn} incidents.
|
||||
:frontmatter-tags-products: [kibana]
|
||||
:frontmatter-tags-content-type: [how-to]
|
||||
:frontmatter-tags-user-goals: [configure]
|
||||
|
||||
The {sn-itsm} connector uses the
|
||||
https://developer.servicenow.com/dev.do#!/reference/api/sandiego/rest/c_ImportSetAPI[import set API]
|
||||
|
|
@ -206,68 +210,6 @@ JWT Key ID:: The key ID assigned to the JWT Verifier Map of your OAuth applicati
|
|||
Private Key:: The RSA private key generated during setup.
|
||||
Private Key Password:: The password for the RSA private key generated during setup, if set.
|
||||
|
||||
[float]
|
||||
[[preconfigured-servicenow-configuration]]
|
||||
=== Create preconfigured connectors
|
||||
|
||||
If you are running {kib} on-prem, you can define connectors by
|
||||
adding `xpack.actions.preconfigured` settings to your `kibana.yml` file.
|
||||
For example:
|
||||
|
||||
Connector using Basic Authentication
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-servicenow:
|
||||
name: preconfigured-servicenow-connector-type
|
||||
actionTypeId: .servicenow
|
||||
config:
|
||||
apiUrl: https://example.service-now.com/
|
||||
usesTableApi: false
|
||||
secrets:
|
||||
username: testuser
|
||||
password: passwordkeystorevalue
|
||||
--
|
||||
|
||||
Connector using OAuth
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-servicenow:
|
||||
name: preconfigured-oauth-servicenow-connector-type
|
||||
actionTypeId: .servicenow
|
||||
config:
|
||||
apiUrl: https://example.service-now.com/
|
||||
usesTableApi: false
|
||||
isOAuth: true
|
||||
userIdentifierValue: testuser@email.com
|
||||
clientId: abcdefghijklmnopqrstuvwxyzabcdef
|
||||
jwtKeyId: fedcbazyxwvutsrqponmlkjihgfedcba
|
||||
secrets:
|
||||
clientSecret: secretsecret
|
||||
privateKey: -----BEGIN RSA PRIVATE KEY-----\nprivatekeyhere\n-----END RSA PRIVATE KEY-----
|
||||
--
|
||||
|
||||
Config defines information for the connector type.
|
||||
|
||||
`apiUrl`:: An address that corresponds to *URL*.
|
||||
`usesTableApi`:: A boolean that indicates if the connector uses the Table API or the Import Set API.
|
||||
|
||||
NOTE: If `usesTableApi` is set to false, the Elastic application should be installed in {sn}.
|
||||
|
||||
`isOAuth`:: A boolean that corresponds to *Is OAuth* and indicates if the connector uses Basic Authentication or OAuth.
|
||||
`userIdentifierValue`:: A string that corresponds to *User Identifier*. Required if `isOAuth` is set to `true`.
|
||||
`clientId`:: A string that corresponds to *Client ID*, used for OAuth authentication. Required if `isOAuth` is set to `true`.
|
||||
`jwtKeyId`:: A string that corresponds to *JWT Key ID*, used for OAuth authentication. Required if `isOAuth` is set to `true`.
|
||||
|
||||
Secrets defines sensitive information for the connector type.
|
||||
|
||||
`username`:: A string that corresponds to *Username*. Required if `isOAuth` is set to `false`.
|
||||
`password`:: A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>. Required if `isOAuth` is set to `false`.
|
||||
`clientSecret`:: A string that corresponds to *Client Secret*. Required if `isOAuth` is set to `true`.
|
||||
`privateKey`:: A string that corresponds to *Private Key*. Required if `isOAuth` is set to `true`.
|
||||
`privateKeyPassword`:: A string that corresponds to *Private Key Password*.
|
||||
|
||||
[float]
|
||||
[[servicenow-action-configuration]]
|
||||
=== Test connectors
|
||||
|
|
|
|||
|
|
@ -117,6 +117,9 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
|
|||
* <<preconfigured-opsgenie-configuration>>
|
||||
* <<preconfigured-pagerduty-configuration>>
|
||||
* <<preconfigured-server-log-configuration>>
|
||||
* <<preconfigured-servicenow-itom-configuration>>
|
||||
* <<preconfigured-servicenow-configuration>>
|
||||
* <<preconfigured-servicenow-sir-configuration>>
|
||||
* <<preconfigured-slack-configuration>>
|
||||
* <<preconfigured-swimlane-configuration>>
|
||||
* <<preconfigured-torq-configuration>>
|
||||
|
|
@ -442,6 +445,155 @@ xpack.actions.preconfigured:
|
|||
actionTypeId: .server-log
|
||||
--
|
||||
|
||||
[float]
|
||||
[[preconfigured-servicenow-itom-configuration]]
|
||||
==== {sn-itom} connectors
|
||||
|
||||
The following example creates a <<servicenow-itom-action-type,{sn-itom} connector>> with basic authentication:
|
||||
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-servicenow-itom:
|
||||
name: preconfigured-servicenow-connector-type
|
||||
actionTypeId: .servicenow-itom
|
||||
config:
|
||||
apiUrl: https://example.service-now.com/ <1>
|
||||
secrets:
|
||||
username: testuser <2>
|
||||
password: passwordkeystorevalue <3>
|
||||
--
|
||||
<1> The ServiceNow instance URL.
|
||||
<2> A user name.
|
||||
<3> A password. NOTE: This value should be stored in the <<creating-keystore, {kib} keystore>>.
|
||||
|
||||
The following example creates a {sn-itom} connector with OAuth authentication:
|
||||
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-servicenow:
|
||||
name: preconfigured-oauth-servicenow-connector-type
|
||||
actionTypeId: .servicenow-itom
|
||||
config:
|
||||
apiUrl: https://example.service-now.com/
|
||||
isOAuth: true <1>
|
||||
userIdentifierValue: testuser@email.com <2>
|
||||
clientId: abcdefghijklmnopqrstuvwxyzabcdef <3>
|
||||
jwtKeyId: fedcbazyxwvutsrqponmlkjihgfedcba <4>
|
||||
secrets:
|
||||
clientSecret: secretsecret <5>
|
||||
privateKey: -----BEGIN RSA PRIVATE KEY-----\nprivatekeyhere\n-----END RSA PRIVATE KEY----- <6>
|
||||
--
|
||||
<1> Specifies whether the connector uses basic or OAuth authentication.
|
||||
<2> The user identifier.
|
||||
<3> The client identifier assigned to your OAuth application.
|
||||
<4> The key identifier assigned to the JWT verifier map of your OAuth application.
|
||||
<5> The client secret assigned to your OAuth application.
|
||||
<6> The RSA private key. If it has a password, you must also provide `privateKeyPassword`.
|
||||
|
||||
[float]
|
||||
[[preconfigured-servicenow-configuration]]
|
||||
==== {sn-itsm} connectors
|
||||
|
||||
The following example creates a <<servicenow-action-type,{sn-itsm} connector>> with basic authentication:
|
||||
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-servicenow:
|
||||
name: preconfigured-servicenow-connector-type
|
||||
actionTypeId: .servicenow
|
||||
config:
|
||||
apiUrl: https://example.service-now.com/ <1>
|
||||
usesTableApi: false <2>
|
||||
secrets:
|
||||
username: testuser <3>
|
||||
password: passwordkeystorevalue <4>
|
||||
--
|
||||
<1> The ServiceNow instance URL.
|
||||
<2> Specifies whether the connector uses the Table API or the Import Set API. If `usesTableApi` is `false`, the Elastic application should be installed in {sn}.
|
||||
<3> The user name.
|
||||
<4> The password. NOTE: This value should be stored in the <<creating-keystore, {kib} keystore>>.
|
||||
|
||||
The following example creates a {sn-itsm} connector with OAuth authentication:
|
||||
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-servicenow:
|
||||
name: preconfigured-oauth-servicenow-connector-type
|
||||
actionTypeId: .servicenow
|
||||
config:
|
||||
apiUrl: https://example.service-now.com/
|
||||
usesTableApi: false
|
||||
isOAuth: true <1>
|
||||
userIdentifierValue: testuser@email.com <2>
|
||||
clientId: abcdefghijklmnopqrstuvwxyzabcdef <3>
|
||||
jwtKeyId: fedcbazyxwvutsrqponmlkjihgfedcba <4>
|
||||
secrets:
|
||||
clientSecret: secretsecret <5>
|
||||
privateKey: -----BEGIN RSA PRIVATE KEY-----\nprivatekeyhere\n-----END RSA PRIVATE KEY----- <6>
|
||||
--
|
||||
<1> Specifies whether the connector uses basic or OAuth authentication.
|
||||
<2> The user identifier.
|
||||
<3> The client identifier assigned to your OAuth application.
|
||||
<4> The key ID assigned to the JWT verifier map of your OAuth application.
|
||||
<5> The client secret assigned to the OAuth application.
|
||||
<6> The RSA private key. If it has a password, you must also provide `privateKeyPassword`.
|
||||
|
||||
[float]
|
||||
[[preconfigured-servicenow-sir-configuration]]
|
||||
==== {sn-sir} connectors
|
||||
|
||||
The following example creates a <<servicenow-sir-action-type,{sn-sir} connector>> with basic authentication:
|
||||
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-servicenow-sir:
|
||||
name: preconfigured-servicenow-connector-type
|
||||
actionTypeId: .servicenow-sir
|
||||
config:
|
||||
apiUrl: https://example.service-now.com/ <1>
|
||||
usesTableApi: false <2>
|
||||
secrets:
|
||||
username: testuser <3>
|
||||
password: passwordkeystorevalue <4>
|
||||
--
|
||||
<1> The ServiceNow instance URL.
|
||||
<2> Specifies whether the connector uses the Table API or the Import Set API. If `usesTableApi` is false, the Elastic application should be installed in {sn}.
|
||||
<3> The user name.
|
||||
<4> The password. NOTE: This value should be stored in the <<creating-keystore, {kib} keystore>>.
|
||||
|
||||
The following example creates a {sn-sir} connector with OAuth authentication:
|
||||
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-servicenow:
|
||||
name: preconfigured-oauth-servicenow-connector-type
|
||||
actionTypeId: .servicenow-sir
|
||||
config:
|
||||
apiUrl: https://example.service-now.com/
|
||||
usesTableApi: false
|
||||
isOAuth: true <1>
|
||||
userIdentifierValue: testuser@email.com <2>
|
||||
clientId: abcdefghijklmnopqrstuvwxyzabcdef <3>
|
||||
jwtKeyId: fedcbazyxwvutsrqponmlkjihgfedcba <4>
|
||||
secrets:
|
||||
clientSecret: secretsecret <5>
|
||||
privateKey: -----BEGIN RSA PRIVATE KEY-----\nprivatekeyhere\n-----END RSA PRIVATE KEY----- <6>
|
||||
--
|
||||
<1> Specifies whether the connector uses basic or OAuth authentication.
|
||||
<2> The user identifier.
|
||||
<3> The client identifier assigned to the OAuth application.
|
||||
<4> The key ID assigned to the JWT verifier map of your OAuth application.
|
||||
<5> The client secret assigned to the OAuth application.
|
||||
<6> The RSA private key. If it has a password, you must also specify
|
||||
`privateKeyPassword`.
|
||||
|
||||
|
||||
[float]
|
||||
[[preconfigured-slack-configuration]]
|
||||
==== Slack connectors
|
||||
|
|
@ -605,7 +757,6 @@ xpack.actions.preconfigured:
|
|||
|
||||
NOTE: SSL authentication is not supported in preconfigured webhook connectors.
|
||||
|
||||
|
||||
[float]
|
||||
[[preconfigured-cases-webhook-configuration]]
|
||||
==== {webhook-cm} connectors
|
||||
|
|
@ -664,7 +815,7 @@ The following example creates an <<xmatters-action-type,xMatters connector>> wit
|
|||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-xmatters:
|
||||
my-xmatters:
|
||||
name: preconfigured-xmatters-connector-type
|
||||
actionTypeId: .xmatters
|
||||
config:
|
||||
|
|
|
|||
|
|
@ -272,6 +272,7 @@ A configuration URL that varies by connector:
|
|||
* For a <<jira-action-type,Jira connector>>, specifies the Jira instance URL.
|
||||
* For an <<opsgenie-action-type,{opsgenie} connector>>, specifies the {opsgenie} URL. For example, `https://api.opsgenie.com` or `https://api.eu.opsgenie.com`.
|
||||
* For a <<pagerduty-action-type,PagerDuty connector>>, specifies the PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`.
|
||||
* For a <<servicenow-action-type,{sn-itsm}>>, <<servicenow-sir-action-type,{sn-sir}>>, or <<servicenow-itom-action-type,{sn-itom} connector>> specifies the ServiceNow instance URL.
|
||||
* For a <<swimlane-action-type,{swimlane} connector>>, specifies the {swimlane} instance URL.
|
||||
|
||||
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname in the URL is added to the allowed hosts.
|
||||
|
|
@ -285,7 +286,12 @@ An application ID that varies by connector:
|
|||
--
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.config.clientId`::
|
||||
For an <<email-action-type,email connector>>, specifies a GUID format value that corresponds to the client ID, which is a part of OAuth 2.0 client credentials authentication.
|
||||
A client identifier that varies by connector:
|
||||
+
|
||||
--
|
||||
* For an <<email-action-type,email connector>>, specifies a GUID format value that corresponds to the client ID, which is a part of OAuth 2.0 client credentials authentication.
|
||||
* For a <<servicenow-itom-action-type,{sn-itom}>>, <<servicenow-action-type,{sn-itsm}>>, or <<servicenow-sir-action-type,{sn-sir} connector>> specifies the client identifier assigned to the OAuth application.
|
||||
--
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.config.configUrl`::
|
||||
For an <<xmatters-action-type,xMatters connector>> with basic authentication, specifies the request URL for the Elastic Alerts trigger in xMatters.
|
||||
|
|
@ -350,6 +356,12 @@ For an <<email-action-type,email connector>>, specifies the host name of the ser
|
|||
`xpack.actions.preconfigured.<connector-id>.config.index`::
|
||||
For an <<index-action-type,index connector>>, specifies the {es} index.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.config.isOAuth`::
|
||||
For a <<servicenow-action-type,{sn-itsm}>>, <<servicenow-sir-action-type,{sn-sir}>>, or <<servicenow-itom-action-type,{sn-itom} connector>>, specifies whether to use basic or OAuth authentication.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.config.jwtKeyId`::
|
||||
For a <<servicenow-action-type,{sn-itsm}>>, <<servicenow-sir-action-type,{sn-sir}>>, or <<servicenow-itom-action-type,{sn-itom} connector>>, specifies the key ID assigned to the JWT verifier map of your OAuth application. It is required when `xpack.actions.preconfigured.<connector-id>.config.isOAuth` is `true`.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.config.mappings`::
|
||||
For a <<swimlane-action-type,Swimlane connector>>, specifies field mappings.
|
||||
|
||||
|
|
@ -427,9 +439,16 @@ A configuration URL that varies by connector:
|
|||
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts.
|
||||
--
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.config.userIdentifierValue`::
|
||||
For a <<servicenow-action-type,{sn-itsm}>>, <<servicenow-sir-action-type,{sn-sir}>>, or <<servicenow-itom-action-type,{sn-itom} connector>>, specifies the user identifier. It is required when required when `xpack.actions.preconfigured.<connector-id>.config.isOAuth` is `true`.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.config.usesBasic`::
|
||||
For an <<xmatters-action-type,xMatters connector>>, specifies whether it uses HTTP basic authentication. Defaults to `true`.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.config.usesTableApi`::
|
||||
For a <<servicenow-action-type,{sn-itsm}>> or <<servicenow-sir-action-type,{sn-sir} connector>>, specifies whether the connector uses the Table API or the Import Set API.
|
||||
If set to `false`, the Elastic application should be installed in ServiceNow.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.config.viewIncidentUrl`::
|
||||
For a <<cases-webhook-action-type,{webhook-cm} connector>>, specifies a URL string with either the external service ID or external service title Mustache variable to view a case in the external system.
|
||||
|
||||
|
|
@ -466,6 +485,7 @@ A client secret that varies by connector:
|
|||
+
|
||||
--
|
||||
* For an <<email-action-type,email connector>>, specifies the client secret that you generated for your app in the app registration portal. It is required when the email service is `exchange_server`, which uses OAuth 2.0 client credentials authentication.
|
||||
* For a <<servicenow-action-type,{sn-itsm}>>, <<servicenow-sir-action-type,{sn-sir}>>, or <<servicenow-itom-action-type,{sn-itom} connector>>, specifies the client secret assigned to the OAuth application. It is required when `xpack.actions.preconfigured.<connector-id>.config.isOAuth` is `true`.
|
||||
|
||||
NOTE: The client secret must be URL-encoded.
|
||||
--
|
||||
|
|
@ -482,10 +502,18 @@ An email address that varies by connector:
|
|||
A password secret that varies by connector:
|
||||
+
|
||||
--
|
||||
|
||||
* For an <<email-action-type,email>>, <<webhook-action-type,webhook>>, or <<cases-webhook-action-type,{webhook-cm} connector>>, specifies a password that is required when `xpack.actions.preconfigured.<connector-id>.config.hasAuth` is `true`.
|
||||
* For a <<servicenow-action-type,{sn-itsm}>>, <<servicenow-sir-action-type,{sn-sir}>>, or <<servicenow-itom-action-type,{sn-itom} connector>>, specifies a password that is required when `xpack.actions.preconfigured.<connector-id>.config.isOAuth` is `false`.
|
||||
* For an <<xmatters-action-type,xMatters connector>>, specifies a password that is required when `xpack.actions.preconfigured.<connector-id>.config.usesBasic` is `true`.
|
||||
--
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.secrets.privateKey`::
|
||||
For a <<servicenow-action-type,{sn-itsm}>>, <<servicenow-sir-action-type,{sn-sir}>>, or <<servicenow-itom-action-type,{sn-itom} connector>>, specifies the RSA private key. It is required when `xpack.actions.preconfigured.<connector-id>.config.isOAuth` is `true`.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.secrets.privateKeyPassword`::
|
||||
For a <<servicenow-action-type,{sn-itsm}>>, <<servicenow-sir-action-type,{sn-sir}>>, or <<servicenow-itom-action-type,{sn-itom} connector>>, specifies the password for the RSA private key.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.secrets.routingKey`::
|
||||
For a <<pagerduty-action-type,PagerDuty connector>>, specifies the 32 character PagerDuty Integration Key for an integration on a service, also referred to as the routing key.
|
||||
|
||||
|
|
@ -523,6 +551,9 @@ For a <<slack-action-type,Slack connector>>, specifies the Slack webhook URL.
|
|||
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname is added to the allowed hosts.
|
||||
--
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.secrets.username`::
|
||||
For a <<servicenow-action-type,{sn-itsm}>>, <<servicenow-sir-action-type,{sn-sir}>>, or <<servicenow-itom-action-type,{sn-itom} connector>>, specifies a user name that is required when `xpack.actions.preconfigured.<connector-id>.config.isOAuth` is `false`.
|
||||
|
||||
[float]
|
||||
[[alert-settings]]
|
||||
=== Alerting settings
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue