enable-user-profile.asciidoc 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. [role="xpack"]
  2. [[security-api-enable-user-profile]]
  3. === Enable user profile API
  4. ++++
  5. <titleabbrev>Enable user profile</titleabbrev>
  6. ++++
  7. .New API reference
  8. [sidebar]
  9. --
  10. For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
  11. --
  12. NOTE: The user profile feature is designed only for use by {kib} and
  13. Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
  14. users and external applications should not call this API directly. Elastic reserves
  15. the right to change or remove this feature in future releases without prior notice.
  16. Enables a user profile so it's visible in
  17. <<security-api-suggest-user-profile,user profile searches>>.
  18. [[security-api-enable-user-profile-request]]
  19. ==== {api-request-title}
  20. `POST /_security/profile/<uid>/_enable`
  21. `PUT /_security/profile/<uid>/_enable`
  22. [[security-api-enable-user-profile-prereqs]]
  23. ==== {api-prereq-title}
  24. To use this API, you must have the `manage_user_profile` cluster privilege.
  25. [[security-api-enable-user-profile-desc]]
  26. ==== {api-description-title}
  27. When you <<security-api-activate-user-profile,activate a user profile>>, it's
  28. automatically enabled and visible in user profile searches. If you later
  29. <<security-api-disable-user-profile,disable the user profile>>, you can use the
  30. enable user profile API to make the profile visible in these searches again.
  31. [[security-api-enable-user-profile-path-params]]
  32. ==== {api-path-parms-title}
  33. `<uid>`::
  34. (Required, string) Unique identifier for the user profile.
  35. [[security-api-enable-user-profile-query-params]]
  36. ==== {api-query-parms-title}
  37. include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh]
  38. [[security-api-enable-user-profile-example]]
  39. ==== {api-examples-title}
  40. The following request enables the user profile for a `uid` matching
  41. `u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0`:
  42. [source,console]
  43. ----
  44. POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_enable
  45. ----
  46. // TEST[setup:user_profiles]