Skip to content

Commit c171a6f

Browse files
authored
[7.x] Document security settings available on ESS (#76513) (#76654)
1 parent 775359c commit c171a6f

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/settings/security-settings.asciidoc

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -73,27 +73,27 @@ The valid settings in the `xpack.security.authc.providers` namespace vary depend
7373
[cols="2*<"]
7474
|===
7575
| `xpack.security.authc.providers.`
76-
`<provider-type>.<provider-name>.enabled`
76+
`<provider-type>.<provider-name>.enabled` {ess-icon}
7777
| Determines if the authentication provider should be enabled. By default, {kib} enables the provider as soon as you configure any of its properties.
7878

7979
| `xpack.security.authc.providers.`
80-
`<provider-type>.<provider-name>.order`
80+
`<provider-type>.<provider-name>.order` {ess-icon}
8181
| Order of the provider in the authentication chain and on the Login Selector UI.
8282

8383
| `xpack.security.authc.providers.`
84-
`<provider-type>.<provider-name>.description`
84+
`<provider-type>.<provider-name>.description` {ess-icon}
8585
| Custom description of the provider entry displayed on the Login Selector UI.
8686

8787
| `xpack.security.authc.providers.`
88-
`<provider-type>.<provider-name>.hint`
88+
`<provider-type>.<provider-name>.hint` {ess-icon}
8989
| Custom hint for the provider entry displayed on the Login Selector UI.
9090

9191
| `xpack.security.authc.providers.`
92-
`<provider-type>.<provider-name>.icon`
92+
`<provider-type>.<provider-name>.icon` {ess-icon}
9393
| Custom icon for the provider entry displayed on the Login Selector UI.
9494

9595
| `xpack.security.authc.providers.`
96-
`<provider-type>.<provider-name>.showInSelector`
96+
`<provider-type>.<provider-name>.showInSelector` {ess-icon}
9797
| Flag that indicates if the provider should have an entry on the Login Selector UI. Setting this to `false` doesn't remove the provider from the authentication chain.
9898

9999
2+a|
@@ -104,7 +104,7 @@ You are unable to set this setting to `false` for `basic` and `token` authentica
104104
============
105105

106106
| `xpack.security.authc.providers.`
107-
`<provider-type>.<provider-name>.accessAgreement.message`
107+
`<provider-type>.<provider-name>.accessAgreement.message` {ess-icon}
108108
| Access agreement text in Markdown format. For more information, refer to <<xpack-security-access-agreement>>.
109109

110110
|===
@@ -118,11 +118,11 @@ In addition to <<authentication-provider-settings,the settings that are valid fo
118118
[cols="2*<"]
119119
|===
120120
| `xpack.security.authc.providers.`
121-
`saml.<provider-name>.realm`
121+
`saml.<provider-name>.realm` {ess-icon}
122122
| SAML realm in {es} that provider should use.
123123

124124
| `xpack.security.authc.providers.`
125-
`saml.<provider-name>.useRelayStateDeepLink`
125+
`saml.<provider-name>.useRelayStateDeepLink` {ess-icon}
126126
| Determines if the provider should treat the `RelayState` parameter as a deep link in {kib} during Identity Provider initiated log in. By default, this setting is set to `false`. The link specified in `RelayState` should be a relative, URL-encoded {kib} URL. For example, the `/app/dashboards#/list` link in `RelayState` parameter would look like this: `RelayState=%2Fapp%2Fdashboards%23%2Flist`.
127127

128128
|===
@@ -136,7 +136,7 @@ In addition to <<authentication-provider-settings,the settings that are valid fo
136136
[cols="2*<"]
137137
|===
138138
| `xpack.security.authc.providers.`
139-
`oidc.<provider-name>.realm`
139+
`oidc.<provider-name>.realm` {ess-icon}
140140
| OpenID Connect realm in {es} that the provider should use.
141141

142142
|===
@@ -168,13 +168,13 @@ You can configure the following settings in the `kibana.yml` file.
168168

169169
[cols="2*<"]
170170
|===
171-
| `xpack.security.loginAssistanceMessage`
171+
| `xpack.security.loginAssistanceMessage` {ess-icon}
172172
| Adds a message to the login UI. Useful for displaying information about maintenance windows, links to corporate sign up pages, and so on.
173173

174-
| `xpack.security.loginHelp`
174+
| `xpack.security.loginHelp` {ess-icon}
175175
| Adds a message accessible at the login UI with additional help information for the login process.
176176

177-
| `xpack.security.authc.selector.enabled`
177+
| `xpack.security.authc.selector.enabled` {ess-icon}
178178
| Determines if the login selector UI should be enabled. By default, this setting is set to `true` if more than one authentication provider is configured.
179179

180180
|===
@@ -203,12 +203,12 @@ You can configure the following settings in the `kibana.yml` file.
203203
this to `true` if SSL is configured outside of {kib} (for example, you are
204204
routing requests through a load balancer or proxy).
205205

206-
| `xpack.security.sameSiteCookies`
206+
| `xpack.security.sameSiteCookies` {ess-icon}
207207
| Sets the `SameSite` attribute of the session cookie. This allows you to declare whether your cookie should be restricted to a first-party or same-site context.
208208
Valid values are `Strict`, `Lax`, `None`.
209209
This is *not set* by default, which modern browsers will treat as `Lax`. If you use Kibana embedded in an iframe in modern browsers, you might need to set it to `None`. Setting this value to `None` requires cookies to be sent over a secure connection by setting `xpack.security.secureCookies: true`. Some old versions of IE11 do not support `SameSite: None`.
210210

211-
| `xpack.security.session.idleTimeout`
211+
| `xpack.security.session.idleTimeout` {ess-icon}
212212
| Ensures that user sessions will expire after a period of inactivity. This and `xpack.security.session.lifespan` are both
213213
highly recommended. By default, this setting is not set.
214214

@@ -218,7 +218,7 @@ highly recommended. By default, this setting is not set.
218218
The format is a string of `<count>[ms\|s\|m\|h\|d\|w\|M\|Y]` (e.g. '20m', '24h', '7d', '1w').
219219
============
220220

221-
| `xpack.security.session.lifespan`
221+
| `xpack.security.session.lifespan` {ess-icon}
222222
| Ensures that user sessions will expire after the defined time period. This behavior also known as an "absolute timeout". If
223223
this is _not_ set, user sessions could stay active indefinitely. This and `xpack.security.session.idleTimeout` are both highly
224224
recommended. By default, this setting is not set.

0 commit comments

Comments
 (0)