github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Improve connector privateKey and certificateAuthoritiesData setting examples (#190932)

Browse source
This commit is contained in:
Lisa Cawley 2024-08-21 12:24:14 -07:00 • committed by GitHub
parent be2f7f414d
commit 385281b2a6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 26 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/management/connectors/pre-configured-connectors.asciidoc
View file

@ -513,14 +513,19 @@ xpack.actions.preconfigured:
jwtKeyId: fedcbazyxwvutsrqponmlkjihgfedcba <4>
secrets:
clientSecret: secretsecret <5>
privateKey: -----BEGIN RSA PRIVATE KEY-----\nprivatekeyhere\n-----END RSA PRIVATE KEY----- <6>
privateKey: | <6>
-----BEGIN RSA PRIVATE KEY-----
MIIE...
KAgD...
... multiple lines of key data ...
-----END RSA PRIVATE KEY-----
--
<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`.
<6> The RSA private key in multiline format. If it has a password, you must also provide `privateKeyPassword`.
[float]
[[preconfigured-servicenow-configuration]]
@ -563,14 +568,19 @@ xpack.actions.preconfigured:
jwtKeyId: fedcbazyxwvutsrqponmlkjihgfedcba <4>
secrets:
clientSecret: secretsecret <5>
privateKey: -----BEGIN RSA PRIVATE KEY-----\nprivatekeyhere\n-----END RSA PRIVATE KEY----- <6>
privateKey: | <6>
-----BEGIN RSA PRIVATE KEY-----
MIIE...
KAgD...
... multiple lines of key data ...
-----END RSA PRIVATE KEY-----
--
<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`.
<6> The RSA private key in multiline format. If it has a password, you must also provide `privateKeyPassword`.
[float]
[[preconfigured-servicenow-sir-configuration]]
@ -613,14 +623,19 @@ xpack.actions.preconfigured:
jwtKeyId: fedcbazyxwvutsrqponmlkjihgfedcba <4>
secrets:
clientSecret: secretsecret <5>
privateKey: -----BEGIN RSA PRIVATE KEY-----\nprivatekeyhere\n-----END RSA PRIVATE KEY----- <6>
privateKey: | <6>
-----BEGIN RSA PRIVATE KEY-----
MIIE...
KAgD...
... multiple lines of key data ...
-----END RSA PRIVATE KEY-----
--
<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
<6> The RSA private key in multiline format. If it has a password, you must also specify
`privateKeyPassword`.

9
docs/settings/alert-action-settings.asciidoc
View file

@ -67,7 +67,9 @@ xpack.actions.customHostSettings:
certificateAuthoritiesFiles: [ 'one.crt' ]
certificateAuthoritiesData: |
-----BEGIN CERTIFICATE-----
... multiple lines of certificate data here ...
MIIDTD...
CwUAMD...
... multiple lines of certificate data ...
-----END CERTIFICATE-----
smtp:
requireTLS: true
@ -125,9 +127,8 @@ A file name or list of file names of PEM-encoded certificate files to use
to validate the server.
`xpack.actions.customHostSettings[n].ssl.certificateAuthoritiesData` {ess-icon}::
The contents of a PEM-encoded certificate file, or multiple files appended
into a single string. This configuration can be used for environments where
the files cannot be made available.
The contents of one or more PEM-encoded certificate files in multiline format.
This configuration can be used for environments where the files cannot be made available.
[[action-config-email-domain-allowlist]] `xpack.actions.email.domain_allowlist` {ess-icon}::
A list of allowed email domains which can be used with the email connector. When this setting is not used, all email domains are allowed. When this setting is used, if any email is attempted to be sent that (a) includes an addressee with an email domain that is not in the allowlist, or (b) includes a from address domain that is not in the allowlist, it will fail with a message indicating the email is not allowed.