Enable a user profile

  • POST also PUT /_security/profile/{uid}/_enable
Auth

Enable user profiles to make them visible in user profile searches.

Note

The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security 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.

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.

Required authorization

Cluster privileges manage_user_profile

Path parameters

uid string required

A unique identifier for the user profile.

Query parameters

refresh enum · default: false

If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', nothing is done with refreshes.

Values: true false wait_for

Response

application/json
acknowledged boolean required

For a successful response, this value is always true. On failure, an exception is returned instead.