2017-06-28 14:02:40 -04:00
|
|
|
[role="xpack"]
|
2017-04-06 21:04:39 -04:00
|
|
|
[[security-api]]
|
|
|
|
== Security APIs
|
|
|
|
|
2018-08-17 12:18:08 -04:00
|
|
|
You can use the following APIs to perform {security} activities.
|
|
|
|
|
2017-04-06 21:04:39 -04:00
|
|
|
* <<security-api-authenticate>>
|
|
|
|
* <<security-api-clear-cache>>
|
2018-01-17 11:14:02 -05:00
|
|
|
* <<security-api-privileges>>
|
2017-06-06 00:12:31 -04:00
|
|
|
* <<security-api-role-mapping>>
|
2018-01-17 11:14:02 -05:00
|
|
|
* <<security-api-ssl>>
|
2017-04-06 21:04:39 -04:00
|
|
|
|
2018-08-18 00:39:21 -04:00
|
|
|
[float]
|
|
|
|
[[security-role-apis]]
|
|
|
|
=== Roles
|
|
|
|
|
|
|
|
You can use the following APIs to add, remove, and retrieve roles in the native realm:
|
|
|
|
|
|
|
|
* <<security-api-put-role,Create role>>, <<security-api-delete-role,Delete role>>
|
|
|
|
* <<security-api-clear-role-cache,Clear roles cache>>
|
|
|
|
* <<security-api-get-role,Get roles>>
|
2018-08-17 12:18:08 -04:00
|
|
|
|
2018-08-18 01:22:09 -04:00
|
|
|
[float]
|
|
|
|
[[security-token-apis]]
|
|
|
|
=== Tokens
|
|
|
|
|
|
|
|
You can use the following APIs to create and invalidate bearer tokens for access
|
|
|
|
without requiring basic authentication:
|
|
|
|
|
|
|
|
* <<security-api-get-token,Get token>>, <<security-api-invalidate-token,Invalidate token>>
|
|
|
|
|
2018-08-18 02:17:33 -04:00
|
|
|
[float]
|
|
|
|
[[security-user-apis]]
|
|
|
|
=== Users
|
|
|
|
|
|
|
|
You can use the following APIs to create, read, update, and delete users from the
|
|
|
|
native realm:
|
|
|
|
|
|
|
|
* <<security-api-put-user,Create users>>, <<security-api-delete-user,Delete users>>
|
|
|
|
* <<security-api-enable-user,Enable users>>, <<security-api-disable-user,Disable users>>
|
|
|
|
* <<security-api-change-password,Change passwords>>
|
|
|
|
* <<security-api-get-user,Get users>>
|
|
|
|
|
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[]
|
|
|
|
include::security/create-roles.asciidoc[]
|
2018-08-18 02:17:33 -04:00
|
|
|
include::security/create-users.asciidoc[]
|
2018-08-17 12:18:08 -04:00
|
|
|
include::security/delete-roles.asciidoc[]
|
2018-08-18 01:22:09 -04:00
|
|
|
include::security/delete-tokens.asciidoc[]
|
2018-08-18 02:17:33 -04:00
|
|
|
include::security/delete-users.asciidoc[]
|
|
|
|
include::security/disable-users.asciidoc[]
|
|
|
|
include::security/enable-users.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[]
|
2018-01-17 11:14:02 -05:00
|
|
|
include::security/privileges.asciidoc[]
|
2017-06-06 00:12:31 -04:00
|
|
|
include::security/role-mapping.asciidoc[]
|
2018-01-17 11:14:02 -05:00
|
|
|
include::security/ssl.asciidoc[]
|