IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Enable user profile API
editEnable user profile API
editThis feature is in development and not yet available for use. This documentation is provided for informational purposes only.
Enables a user profile so it’s visible in user profile searches.
Prerequisites
editTo use this API, you must have the manage_user_profile
cluster privilege.
Description
editWhen you activate a user profile, it’s automatically enabled and visible in user profile searches. If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.
Path parameters
edit-
<uid>
- (Required, string) Unique identifier for the user profile.
Query parameters
edit-
refresh
-
(Optional, enum) If
true
, Elasticsearch refreshes the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
do nothing with refreshes. Valid values:true
,false
,wait_for
. Default:false
.
Examples
editThe following request enables the user profile for a uid
matching
u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0
:
POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_enable