root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/docs/reference/rest-api/security/enable-user-profile.asciidoc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

59 lines
1.8 KiB
Plaintext
Raw Normal View History

User Profile - More REST spec, tests, API docs (#84597) This PR adds REST spec, tests and API docs for: * Enable profile API * Disable profile API * Search profile API Note the docs for Search profile API is intentionally basic because the API itself is still in development. Nevertheless it is still useful to have the basic version to facilitate communications to API consumers.
2022-03-15 08:08:25 +08:00
[role="xpack"]
[[security-api-enable-user-profile]]
=== Enable user profile API
++++
<titleabbrev>Enable user profile</titleabbrev>
++++
Move user profile status to stable and private (#90439) This PR moves the user profile feature and associated APIs from experimental to stable since higher level features built on top of it are going to be GA. The feature and APIs are still kept private because they are meant to internally support higher level features and we don't expect them to be directly used by end-users. This PR also moves the security domain feature to GA by removing the beta label. Security domain requires user configuration to work so it is not something internally controlled by stack and solutions.
2022-09-29 09:14:09 +08:00
NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
the right to change or remove this feature in future releases without prior notice.
User Profile - More REST spec, tests, API docs (#84597) This PR adds REST spec, tests and API docs for: * Enable profile API * Disable profile API * Search profile API Note the docs for Search profile API is intentionally basic because the API itself is still in development. Nevertheless it is still useful to have the basic version to facilitate communications to API consumers.
2022-03-15 08:08:25 +08:00
Enables a user profile so it's visible in
User Profile - rename search to suggest profile (#85196) This PR renames "search profile" to "suggest profile" in all relevant places: * Class names * Variable names * Docs * URL and REST specs
2022-04-01 07:33:23 +08:00
<<security-api-suggest-user-profile,user profile searches>>.
User Profile - More REST spec, tests, API docs (#84597) This PR adds REST spec, tests and API docs for: * Enable profile API * Disable profile API * Search profile API Note the docs for Search profile API is intentionally basic because the API itself is still in development. Nevertheless it is still useful to have the basic version to facilitate communications to API consumers.
2022-03-15 08:08:25 +08:00
[[security-api-enable-user-profile-request]]
==== {api-request-title}
`POST /_security/profile/<uid>/_enable`
`PUT /_security/profile/<uid>/_enable`
[[security-api-enable-user-profile-prereqs]]
==== {api-prereq-title}
To use this API, you must have the `manage_user_profile` cluster privilege.
[[security-api-enable-user-profile-desc]]
==== {api-description-title}
User Profile: Initial beta overview documentations (#83766) Add initial feature overview documentation pages for User Profile and Security Domain. Co-authored-by: Adam Locke <adam.locke@elastic.co> Co-authored-by: Tim Vernum <tim@adjective.org> Co-authored-by: Albert Zaharovits <albert.zaharovits@gmail.com>
2022-04-14 22:38:41 +08:00
When you <<security-api-activate-user-profile,activate a user profile>>, it's
User Profile - More REST spec, tests, API docs (#84597) This PR adds REST spec, tests and API docs for: * Enable profile API * Disable profile API * Search profile API Note the docs for Search profile API is intentionally basic because the API itself is still in development. Nevertheless it is still useful to have the basic version to facilitate communications to API consumers.
2022-03-15 08:08:25 +08:00
automatically enabled and visible in user profile searches. If you later
<<security-api-disable-user-profile,disable the user profile>>, you can use the
enable user profile API to make the profile visible in these searches again.
[[security-api-enable-user-profile-path-params]]
==== {api-path-parms-title}
`<uid>`::
(Required, string) Unique identifier for the user profile.
[[security-api-enable-user-profile-query-params]]
==== {api-query-parms-title}
[DOCS] Refactor book-scoped variables in `docs/reference/index.asciidoc` (#107413) * Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 20:37:07 +08:00
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh]
User Profile - More REST spec, tests, API docs (#84597) This PR adds REST spec, tests and API docs for: * Enable profile API * Disable profile API * Search profile API Note the docs for Search profile API is intentionally basic because the API itself is still in development. Nevertheless it is still useful to have the basic version to facilitate communications to API consumers.
2022-03-15 08:08:25 +08:00
[[security-api-enable-user-profile-example]]
==== {api-examples-title}
The following request enables the user profile for a `uid` matching
[Doc] User Profile - Improve docs for user profile APIs (#87382) This PR adds docs for the new hint parameter of the suggestProfiles API. It also creates proper test setup so that most API call examples in user profile docs are now runnable.
2022-06-04 21:23:20 +08:00
`u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0`:
User Profile - More REST spec, tests, API docs (#84597) This PR adds REST spec, tests and API docs for: * Enable profile API * Disable profile API * Search profile API Note the docs for Search profile API is intentionally basic because the API itself is still in development. Nevertheless it is still useful to have the basic version to facilitate communications to API consumers.
2022-03-15 08:08:25 +08:00
[source,console]
----
[Doc] User Profile - Improve docs for user profile APIs (#87382) This PR adds docs for the new hint parameter of the suggestProfiles API. It also creates proper test setup so that most API call examples in user profile docs are now runnable.
2022-06-04 21:23:20 +08:00
POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_enable
User Profile - More REST spec, tests, API docs (#84597) This PR adds REST spec, tests and API docs for: * Enable profile API * Disable profile API * Search profile API Note the docs for Search profile API is intentionally basic because the API itself is still in development. Nevertheless it is still useful to have the basic version to facilitate communications to API consumers.
2022-03-15 08:08:25 +08:00
----
[Doc] User Profile - Improve docs for user profile APIs (#87382) This PR adds docs for the new hint parameter of the suggestProfiles API. It also creates proper test setup so that most API call examples in user profile docs are now runnable.
2022-06-04 21:23:20 +08:00
// TEST[setup:user_profiles]
User Profile - More REST spec, tests, API docs (#84597) This PR adds REST spec, tests and API docs for: * Enable profile API * Disable profile API * Search profile API Note the docs for Search profile API is intentionally basic because the API itself is still in development. Nevertheless it is still useful to have the basic version to facilitate communications to API consumers.
2022-03-15 08:08:25 +08:00