IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Elasticsearch Guide [8.3] ›REST APIs ›Security APIs
« Activate user profile API Enable user profile API »

Disable user profile APIedit

This 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.

Requestedit

POST /_security/profile/<uid>/_disable

PUT /_security/profile/<uid>/_disable

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. 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 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 disables the user profile for a uid matching u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0:

POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable
« Activate user profile API Enable user profile API »