Skip to content

Commit 4da0180

Browse files
committed
[DOCS] Add links to searchable snapshot and security APIs
1 parent 4012208 commit 4da0180

File tree

70 files changed

+421
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+421
-4
lines changed

docs/reference/rest-api/security.asciidoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
[role="xpack"]
22
[[security-api]]
33
== Security APIs
4+
5+
.New API reference
6+
[sidebar]
7+
--
8+
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
9+
--
10+
411
To use the security APIs, you must set `xpack.security.enabled` to `true` in
512
the `elasticsearch.yml` file.
613

docs/reference/rest-api/security/activate-user-profile.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Activate user profile</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
12+
--
13+
814
NOTE: The user profile feature is designed only for use by {kib} and
915
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
1016
users and external applications should not call this API directly. Elastic reserves

docs/reference/rest-api/security/authenticate.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Authenticate</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
12+
--
13+
814
Enables you to submit a request with a basic auth header to
915
authenticate a user and retrieve information about the authenticated user.
1016

docs/reference/rest-api/security/bulk-create-roles.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Bulk create or update roles API</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
12+
--
13+
814
Bulk adds and updates roles in the native realm.
915

1016
[[security-api-bulk-put-role-request]]

docs/reference/rest-api/security/bulk-delete-roles.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Bulk delete roles API</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
12+
--
13+
814
Bulk deletes roles in the native realm.
915

1016
[[security-api-bulk-delete-role-request]]

docs/reference/rest-api/security/bulk-update-api-keys.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
<titleabbrev>Bulk update API keys</titleabbrev>
77
++++
88

9+
.New API reference
10+
[sidebar]
11+
--
12+
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
13+
--
14+
915
[[security-api-bulk-update-api-keys-request]]
1016
==== {api-request-title}
1117

docs/reference/rest-api/security/change-password.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Change passwords</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
12+
--
13+
814
Changes the passwords of users in the native realm and built-in users.
915

1016
[[security-api-change-password-request]]

docs/reference/rest-api/security/clear-api-key-cache.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Clear API key cache</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
12+
--
13+
814
Evicts a subset of all entries from the API key cache.
915
The cache is also automatically cleared on state changes of the security index.
1016

docs/reference/rest-api/security/clear-cache.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Clear cache</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
12+
--
13+
814
Evicts users from the user cache. You can completely clear
915
the cache or evict specific users.
1016

docs/reference/rest-api/security/clear-privileges-cache.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
<titleabbrev>Clear privileges cache</titleabbrev>
66
++++
77

8+
.New API reference
9+
[sidebar]
10+
--
11+
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
12+
--
13+
814
Evicts privileges from the native application privilege cache.
915
The cache is also automatically cleared for applications that have their privileges updated.
1016

0 commit comments

Comments
 (0)