IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Disable user profile API
editDisable user profile API
editThis feature is in development and not yet available for use. This documentation is provided for informational purposes only.
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_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 disables the user profile for a uid
matching
u_kd2JMqwUQwSCCOxMv7M1vw
:
POST /_security/profile/u_kd2JMqwUQwSCCOxMv7M1vw/_disable