Get a user profile

GET /_security/profile/{uid}

Auth

Get a user's profile using the unique profile ID.

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.

Required privileges

Cluster privileges read_security

Path parameters

uid union string | string[] required: A unique identifier for the user profile.

Query parameters

data union string | string[]: A comma-separated list of filters for the data field of the profile document. To return all content use data=*. To return a subset of content use data=<key> to retrieve content nested under the specified <key>. By default returns no data content.

Response

application/json

profiles object[] required: A successful call returns the JSON representation of the user profile and its internal versioning numbers. The API returns an empty object if no profile document is found for the provided uid. The content of the data field is not returned by default to avoid deserializing a potential large payload.
errors object