security.asciidoc 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  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-has-privileges>>
  8. * <<security-api-ssl>>
  9. [float]
  10. [[security-api-app-privileges]]
  11. === Application privileges
  12. You can use the following APIs to add, update, retrieve, and remove application
  13. privileges:
  14. * <<security-api-put-privileges,Create or update privileges>>
  15. * <<security-api-delete-privilege,Delete privileges>>
  16. * <<security-api-get-privileges,Get privileges>>
  17. [float]
  18. [[security-role-mapping-apis]]
  19. === Role mappings
  20. You can use the following APIs to add, remove, update, and retrieve role mappings:
  21. * <<security-api-put-role-mapping,Create or update role mappings>>
  22. * <<security-api-delete-role-mapping,Delete role mappings>>
  23. * <<security-api-get-role-mapping,Get role mappings>>
  24. [float]
  25. [[security-role-apis]]
  26. === Roles
  27. You can use the following APIs to add, remove, update, and retrieve roles in the native realm:
  28. * <<security-api-put-role,Create or update roles>>
  29. * <<security-api-clear-role-cache,Clear roles cache>>
  30. * <<security-api-delete-role,Delete roles>>
  31. * <<security-api-get-role,Get roles>>
  32. [float]
  33. [[security-token-apis]]
  34. === Tokens
  35. You can use the following APIs to create and invalidate bearer tokens for access
  36. without requiring basic authentication:
  37. * <<security-api-get-token,Get token>>
  38. * <<security-api-invalidate-token,Invalidate token>>
  39. [float]
  40. [[security-api-keys]]
  41. === API Keys
  42. You can use the following APIs to create, retrieve and invalidate API keys for access
  43. without requiring basic authentication:
  44. * <<security-api-create-api-key,Create API Key>>
  45. * <<security-api-get-api-key,Get API Key>>
  46. * <<security-api-invalidate-api-key,Invalidate API Key>>
  47. [float]
  48. [[security-user-apis]]
  49. === Users
  50. You can use the following APIs to add, remove, update, or retrieve users in the
  51. native realm:
  52. * <<security-api-put-user,Create or update users>>
  53. * <<security-api-change-password,Change passwords>>
  54. * <<security-api-delete-user,Delete users>>
  55. * <<security-api-disable-user,Disable users>>
  56. * <<security-api-enable-user,Enable users>>
  57. * <<security-api-get-user,Get users>>
  58. include::security/authenticate.asciidoc[]
  59. include::security/change-password.asciidoc[]
  60. include::security/clear-cache.asciidoc[]
  61. include::security/clear-roles-cache.asciidoc[]
  62. include::security/put-app-privileges.asciidoc[]
  63. include::security/create-role-mappings.asciidoc[]
  64. include::security/create-roles.asciidoc[]
  65. include::security/create-users.asciidoc[]
  66. include::security/delete-app-privileges.asciidoc[]
  67. include::security/delete-role-mappings.asciidoc[]
  68. include::security/delete-roles.asciidoc[]
  69. include::security/delete-users.asciidoc[]
  70. include::security/disable-users.asciidoc[]
  71. include::security/enable-users.asciidoc[]
  72. include::security/get-app-privileges.asciidoc[]
  73. include::security/get-role-mappings.asciidoc[]
  74. include::security/get-roles.asciidoc[]
  75. include::security/get-tokens.asciidoc[]
  76. include::security/get-users.asciidoc[]
  77. include::security/has-privileges.asciidoc[]
  78. include::security/invalidate-tokens.asciidoc[]
  79. include::security/ssl.asciidoc[]
  80. include::security/create-api-keys.asciidoc[]
  81. include::security/invalidate-api-keys.asciidoc[]
  82. include::security/get-api-keys.asciidoc[]