2017-06-28 14:02:40 -04:00
|
|
|
[role="xpack"]
|
2017-04-06 21:04:39 -04:00
|
|
|
[[security-api]]
|
|
|
|
== Security APIs
|
|
|
|
|
2018-12-19 17:53:37 -05:00
|
|
|
You can use the following APIs to perform security activities.
|
2018-08-17 12:18:08 -04:00
|
|
|
|
2017-04-06 21:04:39 -04:00
|
|
|
* <<security-api-authenticate>>
|
|
|
|
* <<security-api-clear-cache>>
|
2019-08-27 07:42:46 -04:00
|
|
|
* <<security-api-delegate-pki-authentication>>
|
2018-08-23 21:04:02 -04:00
|
|
|
* <<security-api-has-privileges>>
|
2018-01-17 11:14:02 -05:00
|
|
|
* <<security-api-ssl>>
|
2019-07-03 05:08:28 -04:00
|
|
|
* <<security-api-get-builtin-privileges>>
|
2017-04-06 21:04:39 -04:00
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-08-23 21:04:02 -04:00
|
|
|
[[security-api-app-privileges]]
|
|
|
|
=== Application privileges
|
2018-08-18 00:39:21 -04:00
|
|
|
|
2020-07-01 21:50:03 -04:00
|
|
|
You can use the following APIs to add, update, retrieve, and remove application
|
2018-08-23 21:04:02 -04:00
|
|
|
privileges:
|
2018-08-18 00:39:21 -04:00
|
|
|
|
2020-07-01 21:50:03 -04:00
|
|
|
* <<security-api-put-privileges,Create or update privileges>>
|
|
|
|
* <<security-api-clear-privilege-cache,Clear privileges cache>>
|
2018-08-23 21:04:02 -04:00
|
|
|
* <<security-api-delete-privilege,Delete privileges>>
|
|
|
|
* <<security-api-get-privileges,Get privileges>>
|
2018-08-17 12:18:08 -04:00
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-08-20 17:30:42 -04:00
|
|
|
[[security-role-mapping-apis]]
|
|
|
|
=== Role mappings
|
|
|
|
|
2018-08-23 21:04:02 -04:00
|
|
|
You can use the following APIs to add, remove, update, and retrieve role mappings:
|
2018-08-20 17:30:42 -04:00
|
|
|
|
2020-07-01 21:50:03 -04:00
|
|
|
* <<security-api-put-role-mapping,Create or update role mappings>>
|
2018-08-23 21:04:02 -04:00
|
|
|
* <<security-api-delete-role-mapping,Delete role mappings>>
|
2018-08-20 17:30:42 -04:00
|
|
|
* <<security-api-get-role-mapping,Get role mappings>>
|
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-08-23 21:04:02 -04:00
|
|
|
[[security-role-apis]]
|
|
|
|
=== Roles
|
|
|
|
|
|
|
|
You can use the following APIs to add, remove, update, and retrieve roles in the native realm:
|
|
|
|
|
|
|
|
* <<security-api-put-role,Create or update roles>>
|
|
|
|
* <<security-api-clear-role-cache,Clear roles cache>>
|
|
|
|
* <<security-api-delete-role,Delete roles>>
|
|
|
|
* <<security-api-get-role,Get roles>>
|
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-08-18 01:22:09 -04:00
|
|
|
[[security-token-apis]]
|
|
|
|
=== Tokens
|
|
|
|
|
|
|
|
You can use the following APIs to create and invalidate bearer tokens for access
|
|
|
|
without requiring basic authentication:
|
|
|
|
|
2018-08-23 21:04:02 -04:00
|
|
|
* <<security-api-get-token,Get token>>
|
|
|
|
* <<security-api-invalidate-token,Invalidate token>>
|
2018-08-18 01:22:09 -04:00
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2019-02-04 22:21:57 -05:00
|
|
|
[[security-api-keys]]
|
|
|
|
=== API Keys
|
|
|
|
|
|
|
|
You can use the following APIs to create, retrieve and invalidate API keys for access
|
|
|
|
without requiring basic authentication:
|
|
|
|
|
2020-10-16 18:41:46 -04:00
|
|
|
* <<security-api-create-api-key,Create API key>>
|
|
|
|
* <<security-api-get-api-key,Get API key>>
|
|
|
|
* <<security-api-invalidate-api-key,Invalidate API key>>
|
2020-10-06 08:49:23 -04:00
|
|
|
* <<security-api-clear-api-key-cache,Clear API key cache>>
|
2020-10-16 18:41:46 -04:00
|
|
|
* <<security-api-grant-api-key,Grant API key>>
|
2019-02-04 22:21:57 -05:00
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2018-08-18 02:17:33 -04:00
|
|
|
[[security-user-apis]]
|
|
|
|
=== Users
|
|
|
|
|
2018-08-23 21:04:02 -04:00
|
|
|
You can use the following APIs to add, remove, update, or retrieve users in the
|
2018-08-18 02:17:33 -04:00
|
|
|
native realm:
|
|
|
|
|
2018-08-23 21:04:02 -04:00
|
|
|
* <<security-api-put-user,Create or update users>>
|
2018-08-18 02:17:33 -04:00
|
|
|
* <<security-api-change-password,Change passwords>>
|
2018-08-23 21:04:02 -04:00
|
|
|
* <<security-api-delete-user,Delete users>>
|
|
|
|
* <<security-api-disable-user,Disable users>>
|
|
|
|
* <<security-api-enable-user,Enable users>>
|
2018-08-18 02:17:33 -04:00
|
|
|
* <<security-api-get-user,Get users>>
|
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2019-06-04 07:08:41 -04:00
|
|
|
[[security-openid-apis]]
|
2019-04-22 08:38:41 -04:00
|
|
|
=== OpenID Connect
|
|
|
|
|
|
|
|
You can use the following APIs to authenticate users against an OpenID Connect
|
2019-10-11 09:34:11 -04:00
|
|
|
authentication realm when using a custom web application other than Kibana
|
2019-04-22 08:38:41 -04:00
|
|
|
|
|
|
|
* <<security-api-oidc-prepare-authentication, Prepare an authentication request>>
|
|
|
|
* <<security-api-oidc-authenticate, Submit an authentication response>>
|
|
|
|
* <<security-api-oidc-logout, Logout an authenticated user>>
|
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2019-10-11 09:34:11 -04:00
|
|
|
[[security-saml-apis]]
|
|
|
|
=== SAML
|
|
|
|
|
|
|
|
You can use the following APIs to authenticate users against a SAML authentication
|
|
|
|
realm when using a custom web application other than Kibana
|
|
|
|
|
|
|
|
* <<security-api-saml-prepare-authentication, Prepare an authentication request>>
|
|
|
|
* <<security-api-saml-authenticate, Submit an authentication response>>
|
|
|
|
* <<security-api-saml-logout, Logout an authenticated user>>
|
|
|
|
* <<security-api-saml-invalidate, Submit a logout request from the IdP>>
|
|
|
|
|
2018-08-23 21:04:02 -04:00
|
|
|
|
2017-04-06 21:04:39 -04:00
|
|
|
include::security/authenticate.asciidoc[]
|
|
|
|
include::security/change-password.asciidoc[]
|
|
|
|
include::security/clear-cache.asciidoc[]
|
2018-08-17 12:18:08 -04:00
|
|
|
include::security/clear-roles-cache.asciidoc[]
|
2020-07-01 21:50:03 -04:00
|
|
|
include::security/clear-privileges-cache.asciidoc[]
|
2020-10-06 08:49:23 -04:00
|
|
|
include::security/clear-api-key-cache.asciidoc[]
|
2019-03-04 18:06:00 -05:00
|
|
|
include::security/create-api-keys.asciidoc[]
|
2018-12-20 13:23:28 -05:00
|
|
|
include::security/put-app-privileges.asciidoc[]
|
|
|
|
include::security/create-role-mappings.asciidoc[]
|
2018-08-17 12:18:08 -04:00
|
|
|
include::security/create-roles.asciidoc[]
|
2018-08-18 02:17:33 -04:00
|
|
|
include::security/create-users.asciidoc[]
|
2019-08-27 07:42:46 -04:00
|
|
|
include::security/delegate-pki-authentication.asciidoc[]
|
2018-08-23 21:04:02 -04:00
|
|
|
include::security/delete-app-privileges.asciidoc[]
|
2018-08-20 17:30:42 -04:00
|
|
|
include::security/delete-role-mappings.asciidoc[]
|
2018-08-17 12:18:08 -04:00
|
|
|
include::security/delete-roles.asciidoc[]
|
2018-08-18 02:17:33 -04:00
|
|
|
include::security/delete-users.asciidoc[]
|
|
|
|
include::security/disable-users.asciidoc[]
|
|
|
|
include::security/enable-users.asciidoc[]
|
2019-03-04 18:06:00 -05:00
|
|
|
include::security/get-api-keys.asciidoc[]
|
2018-08-23 21:04:02 -04:00
|
|
|
include::security/get-app-privileges.asciidoc[]
|
2019-07-03 05:08:28 -04:00
|
|
|
include::security/get-builtin-privileges.asciidoc[]
|
2018-08-20 17:30:42 -04:00
|
|
|
include::security/get-role-mappings.asciidoc[]
|
2018-08-17 12:18:08 -04:00
|
|
|
include::security/get-roles.asciidoc[]
|
2018-08-18 01:22:09 -04:00
|
|
|
include::security/get-tokens.asciidoc[]
|
2018-08-18 02:17:33 -04:00
|
|
|
include::security/get-users.asciidoc[]
|
2020-10-16 18:41:46 -04:00
|
|
|
include::security/grant-api-keys.asciidoc[]
|
2018-08-23 21:04:02 -04:00
|
|
|
include::security/has-privileges.asciidoc[]
|
2019-03-04 18:06:00 -05:00
|
|
|
include::security/invalidate-api-keys.asciidoc[]
|
2018-11-21 02:32:56 -05:00
|
|
|
include::security/invalidate-tokens.asciidoc[]
|
2019-04-22 08:38:41 -04:00
|
|
|
include::security/oidc-prepare-authentication-api.asciidoc[]
|
|
|
|
include::security/oidc-authenticate-api.asciidoc[]
|
|
|
|
include::security/oidc-logout-api.asciidoc[]
|
2019-10-11 09:34:11 -04:00
|
|
|
include::security/saml-prepare-authentication-api.asciidoc[]
|
|
|
|
include::security/saml-authenticate-api.asciidoc[]
|
|
|
|
include::security/saml-logout-api.asciidoc[]
|
|
|
|
include::security/saml-invalidate-api.asciidoc[]
|
2019-06-04 07:08:41 -04:00
|
|
|
include::security/ssl.asciidoc[]
|