-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into revert-164574-task-manager/force-task-state-…
…validation
- Loading branch information
Showing
91 changed files
with
367 additions
and
287 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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: [email protected] | ||
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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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: [email protected] | ||
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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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: [email protected] | ||
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 | ||
|
Oops, something went wrong.