elasticsearch/docs/reference/rest-api/security/disable-user-profile.asciidoc

[role="xpack"]
[[security-api-disable-user-profile]]
=== Disable user profile API
++++
<titleabbrev>Disable user profile</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs].
--

NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
the right to change or remove this feature in future releases without prior notice.

Disables a user profile so it's not visible in
<<security-api-suggest-user-profile,user profile searches>>.

[[security-api-disable-user-profile-request]]
==== {api-request-title}

`POST /_security/profile/<uid>/_disable`

`PUT /_security/profile/<uid>/_disable`

[[security-api-disable-user-profile-prereqs]]
==== {api-prereq-title}

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

[[security-api-disable-user-profile-desc]]
==== {api-description-title}

When you <<security-api-activate-user-profile,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
<<security-api-enable-user-profile,enable user profile API>> .

[[security-api-disable-user-profile-path-params]]
==== {api-path-parms-title}

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

[[security-api-disable-user-profile-query-params]]
==== {api-query-parms-title}

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh]



[[security-api-disable-user-profile-example]]
==== {api-examples-title}

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

[source,console]
----
POST /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0/_disable
----
// TEST[setup:user_profiles]