Skip to content

Commit c95df79

Browse files
authored
[DOCS] Adds get setting and update settings asciidoc files to security API index (#104916) (#104924)
* [DOCS] Adds get setting and update settings asciidoc files to security API index. * [DOCS] Fixes references in docs.
1 parent 98d1c72 commit c95df79

File tree

3 files changed

+28
-11
lines changed

3 files changed

+28
-11
lines changed

docs/reference/rest-api/security.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@ include::security/get-role-mappings.asciidoc[]
187187
include::security/get-roles.asciidoc[]
188188
include::security/get-service-accounts.asciidoc[]
189189
include::security/get-service-credentials.asciidoc[]
190+
include::security/get-settings.asciidoc[]
190191
include::security/get-tokens.asciidoc[]
191192
include::security/get-user-privileges.asciidoc[]
192193

@@ -200,6 +201,7 @@ include::security/oidc-authenticate-api.asciidoc[]
200201
include::security/oidc-logout-api.asciidoc[]
201202
include::security/query-api-key.asciidoc[]
202203
include::security/update-api-key.asciidoc[]
204+
include::security/update-settings.asciidoc[]
203205
include::security/bulk-update-api-keys.asciidoc[]
204206
include::security/saml-prepare-authentication-api.asciidoc[]
205207
include::security/saml-authenticate-api.asciidoc[]

docs/reference/rest-api/security/get-settings.asciidoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,21 @@
55
<titleabbrev>Get Security settings</titleabbrev>
66
++++
77

8+
[[security-api-get-settings-prereqs]]
89
==== {api-prereq-title}
910

1011
* To use this API, you must have at least the `read_security` cluster privilege.
1112

13+
[[security-api-get-settings-desc]]
1214
==== {api-description-title}
13-
This API allows a user to retrieve the user-configurable settings for the Security internal index (`.security` and associated indices). Only a subset of the index settings — those that are user-configurable—will be shown. This includes:
15+
This API allows a user to retrieve the user-configurable settings for the
16+
Security internal index (`.security` and associated indices). Only a subset of
17+
the index settings — those that are user-configurable—will be shown. This includes:
1418

1519
- `index.auto_expand_replicas`
1620
- `index.number_of_replicas`
1721

18-
An example of retrieving the Security settings:
22+
An example of retrieving the security settings:
1923

2024
[source,console]
2125
-----------------------------------------------------------
@@ -24,4 +28,5 @@ GET /_security/settings
2428
// TEST[setup:user_profiles]
2529
// TEST[setup:service_token42]
2630

27-
The configurable settings can be modified using the <<security-api-update-settings,Update Security index settings>> API.
31+
The configurable settings can be modified using the
32+
<<security-api-update-settings,Update Security index settings>> API.

docs/reference/rest-api/security/update-settings.asciidoc

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,16 @@
55
<titleabbrev>Update Security settings</titleabbrev>
66
++++
77

8+
[[security-api-update-settings-prereqs]]
89
==== {api-prereq-title}
910

1011
* To use this API, you must have at least the `manage_security` cluster privilege.
1112

13+
[[security-api-update-settings-desc]]
1214
==== {api-description-title}
13-
This API allows a user to modify the settings for the Security internal indices (`.security` and associated indices). Only a subset of settings are allowed to be modified. This includes:
15+
This API allows a user to modify the settings for the Security internal indices
16+
(`.security` and associated indices). Only a subset of settings are allowed to
17+
be modified. This includes:
1418

1519
- `index.auto_expand_replicas`
1620
- `index.number_of_replicas`
@@ -34,17 +38,23 @@ PUT /_security/settings
3438
-----------------------------------------------------------
3539
// TEST[skip:making sure all the indices have been created reliably is difficult]
3640

37-
The configured settings can be retrieved using the <<security-api-get-settings,Get Security index settings>> API. If a
38-
given index is not in use on the system, but settings are provided for it, the request will be rejected - this API does
39-
not yet support configuring the settings for these indices before they are in use.
41+
The configured settings can be retrieved using the
42+
<<security-api-get-settings,Get Security index settings>> API. If a given index
43+
is not in use on the system, but settings are provided for it, the request will
44+
be rejected - this API does not yet support configuring the settings for these
45+
indices before they are in use.
46+
4047

4148
==== {api-request-body-title}
49+
4250
`security`::
43-
(Optional, object) Settings to be used for the index used for most security configuration, including Native realm users
44-
and roles configured via the API.
51+
(Optional, object) Settings to be used for the index used for most security
52+
configuration, including Native realm users and roles configured via the API.
4553

4654
`security-tokens`::
47-
(Optional, object) Settings to be used for the index used to store <<tokens,security-api-get-token>>.
55+
(Optional, object) Settings to be used for the index used to store
56+
<<security-api-get-token,tokens>>.
4857

4958
`security`::
50-
(Optional, object) Settings to be used for the index used to store <<Profile,security-api-activate-user-profile>> information.
59+
(Optional, object) Settings to be used for the index used to store
60+
<<security-api-activate-user-profile, profile>> information.

0 commit comments

Comments
 (0)