Disable user profile API
editDisable user profile API
editThis 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.
Disables a user profile so it’s not 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. You can use the disable user profile API to disable a user profile so it’s not visible in these searches.
To re-enable a disabled user profile, use the enable user profile API .
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_forthen wait for a refresh to make this operation visible to search, iffalsedo nothing with refreshes. Valid values:true,false,wait_for. Default:false.
Examples
editThe following request disables the user profile for a uid matching
u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0:
POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable