Enable user profile APIedit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Enables a user profile so it’s visible in user profile searches.

Requestedit

POST /_security/profile/<uid>/_enable

PUT /_security/profile/<uid>/_enable

Prerequisitesedit

To use this API, you must have the manage_user_profile cluster privilege.

Descriptionedit

When 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 parametersedit

<uid>
(Required, string) Unique identifier for the user profile.

Query parametersedit

refresh
(Optional, enum) If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. Valid values: true, false, wait_for. Default: false.

Examplesedit

The following request enables the user profile for a uid matching u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0:

POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_enable