Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/reference/rest-api/security.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
[role="xpack"]
[[security-api]]
== Security APIs

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

To use the security APIs, you must set `xpack.security.enabled` to `true` in
the `elasticsearch.yml` file.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Activate user profile</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/authenticate.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Authenticate</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Enables you to submit a request with a basic auth header to
authenticate a user and retrieve information about the authenticated user.

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/bulk-create-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Bulk create or update roles API</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Bulk adds and updates roles in the native realm.

[[security-api-bulk-put-role-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/bulk-delete-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Bulk delete roles API</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Bulk deletes roles in the native realm.

[[security-api-bulk-delete-role-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@
<titleabbrev>Bulk update API keys</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

[[security-api-bulk-update-api-keys-request]]
==== {api-request-title}

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/change-password.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Change passwords</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Changes the passwords of users in the native realm and built-in users.

[[security-api-change-password-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/clear-api-key-cache.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Clear API key cache</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Evicts a subset of all entries from the API key cache.
The cache is also automatically cleared on state changes of the security index.

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/clear-cache.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Clear cache</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Evicts users from the user cache. You can completely clear
the cache or evict specific users.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Clear privileges cache</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Evicts privileges from the native application privilege cache.
The cache is also automatically cleared for applications that have their privileges updated.

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/clear-roles-cache.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Clear roles cache</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Evicts roles from the native role cache.

[[security-api-clear-role-cache-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@
<titleabbrev>Clear service account token caches</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Evicts a subset of all entries from the <<service-accounts,service account>>
token caches.

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/create-api-keys.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Create API keys</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Creates an API key for access without requiring basic authentication.

[[security-api-create-api-key-request]]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
[role="xpack"]
[[security-api-create-cross-cluster-api-key]]
=== Create Cross-Cluster API key API

++++
<titleabbrev>Create Cross-Cluster API key</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Creates an API key of the `cross_cluster` type for the <<remote-clusters-api-key,API key based remote cluster>> access.
A `cross_cluster` API key cannot be used to authenticate through the REST interface.
On the contrary, a <<security-api-create-api-key,REST API key>> is meant to be used through the REST interface
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Create or update role mappings</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Creates and updates role mappings.

[[security-api-put-role-mapping-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/create-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Create or update roles</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Adds and updates roles in the native realm.

[[security-api-put-role-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Create service account tokens</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Creates a <<service-accounts,service accounts>> token for access without requiring basic
authentication.

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/create-users.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Create or update users</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Adds and updates users in the native realm. These users are commonly referred
to as _native users_.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Delegate PKI authentication</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Implements the exchange of an _X509Certificate_ chain into an {es} access
token.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Delete application privileges</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Removes <<application-privileges,application privileges>>.

[[security-api-delete-privilege-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Delete role mappings</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Removes role mappings.

[[security-api-delete-role-mapping-request]]
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/delete-roles.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Delete roles</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Removes roles in the native realm.

[[security-api-delete-role-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Delete service account token</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Deletes <<service-accounts,service account>> tokens for a `service` in a
specified `namespace`.

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/delete-users.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Delete users</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Deletes users from the native realm.

[[security-api-delete-user-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Disable user profile</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/disable-users.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Disable users</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Disables users in the native realm.


Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/enable-user-profile.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Enable user profile</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/enable-users.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<titleabbrev>Enable users</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Enables users in the native realm.


Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/enroll-kibana.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
<titleabbrev>Enroll {kib}</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Enables a {kib} instance to configure itself for communication with a secured {es} cluster.

NOTE: This API is currently intended for internal use only by {kib}.
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/rest-api/security/enroll-node.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
<titleabbrev>Enroll node</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

Allows a new node to join an existing cluster with security features enabled.

[[security-api-node-enrollment-api-request]]
Expand Down
Loading