Files
elasticsearch-js/docs/reference-security-enable_user_profile.asciidoc
2024-12-05 14:46:46 -06:00

62 lines
4.0 KiB
Plaintext

[[reference-security-enable_user_profile]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.security.enableUserProfile
Enable a user profile. Enable user profiles to make them visible in user profile searches.
{ref}/security-api-enable-user-profile.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SecurityEnableUserProfileRequest, options?): Promise<SecurityEnableUserProfileResponse>
----
[discrete]
===== `SecurityEnableUserProfileRequest`
[source,ts]
----
interface SecurityEnableUserProfileRequest extends <<shared-type-request-base, RequestBase>> {
uid: SecurityUserProfileId
refresh?: <<shared-type-refresh, Refresh>>
}
----
[discrete]
===== `SecurityEnableUserProfileResponse`
[source,ts]
----
type SecurityEnableUserProfileResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
----