65 lines
4.0 KiB
Plaintext
65 lines
4.0 KiB
Plaintext
[[reference-security-get_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.getUserProfile
|
|
|
|
Get a user profile. Get a user's profile using the unique profile ID.
|
|
|
|
{ref}/security-api-get-user-profile.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(SecurityGetUserProfileRequest, options?): Promise<SecurityGetUserProfileResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `SecurityGetUserProfileRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface SecurityGetUserProfileRequest extends <<shared-type-request-base, RequestBase>> {
|
|
uid: SecurityUserProfileId | SecurityUserProfileId[]
|
|
data?: string | string[]
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `SecurityGetUserProfileResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface SecurityGetUserProfileResponse {
|
|
profiles: SecurityUserProfileWithMetadata[]
|
|
errors?: SecurityGetUserProfileGetUserProfileErrors
|
|
}
|
|
----
|
|
|