security.asciidoc 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. [role="xpack"]
  2. [[security-api]]
  3. == Security APIs
  4. You can use the following APIs to perform {security} activities.
  5. * <<security-api-authenticate>>
  6. * <<security-api-clear-cache>>
  7. * <<security-api-privileges>>
  8. * <<security-api-role-mapping>>
  9. * <<security-api-ssl>>
  10. [float]
  11. [[security-role-apis]]
  12. === Roles
  13. You can use the following APIs to add, remove, and retrieve roles in the native realm:
  14. * <<security-api-put-role,Create role>>, <<security-api-delete-role,Delete role>>
  15. * <<security-api-clear-role-cache,Clear roles cache>>
  16. * <<security-api-get-role,Get roles>>
  17. [float]
  18. [[security-token-apis]]
  19. === Tokens
  20. You can use the following APIs to create and invalidate bearer tokens for access
  21. without requiring basic authentication:
  22. * <<security-api-get-token,Get token>>, <<security-api-invalidate-token,Invalidate token>>
  23. [float]
  24. [[security-user-apis]]
  25. === Users
  26. You can use the following APIs to create, read, update, and delete users from the
  27. native realm:
  28. * <<security-api-put-user,Create users>>, <<security-api-delete-user,Delete users>>
  29. * <<security-api-enable-user,Enable users>>, <<security-api-disable-user,Disable users>>
  30. * <<security-api-change-password,Change passwords>>
  31. * <<security-api-get-user,Get users>>
  32. include::security/authenticate.asciidoc[]
  33. include::security/change-password.asciidoc[]
  34. include::security/clear-cache.asciidoc[]
  35. include::security/clear-roles-cache.asciidoc[]
  36. include::security/create-roles.asciidoc[]
  37. include::security/create-users.asciidoc[]
  38. include::security/delete-roles.asciidoc[]
  39. include::security/delete-tokens.asciidoc[]
  40. include::security/delete-users.asciidoc[]
  41. include::security/disable-users.asciidoc[]
  42. include::security/enable-users.asciidoc[]
  43. include::security/get-roles.asciidoc[]
  44. include::security/get-tokens.asciidoc[]
  45. include::security/get-users.asciidoc[]
  46. include::security/privileges.asciidoc[]
  47. include::security/role-mapping.asciidoc[]
  48. include::security/ssl.asciidoc[]