Get user profiles API
editGet user profiles API
editThe 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.
Retrieves user profiles using a list of unique profile ID.
Request
editGET /_security/profile/<uid>
Prerequisites
editTo use this API, you must have at least the read_security
cluster privilege (or a greater privilege
such as manage_user_profile
or manage_security
).
Description
editThe get user profile API returns the user profile document matching a specified
uid
, which is generated when
activating a user profile.
Path parameters
edit-
uid
- (Required, string) The unique identifier for the user profile. You can specify multiple IDs as a comma-separated list.
Query parameters
edit-
data
-
(Optional, string) Comma-separated list of filters for the
data
field of the profile document. To return all content, usedata=*
. To return a subset of content, usedata=<key>
to retrieve the content nested under the specified<key>
. Defaults to returning no content.
Response body
editA 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.
Examples
editGET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0
The API returns the following response for a uid
matching u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0
:
{ "profiles": [ { "uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0", "enabled": true, "last_synchronized": 1642650651037, "user": { "username": "jacknich", "roles": [ "admin", "other_role1" ], "realm_name": "native", "full_name": "Jack Nicholson", "email": "jacknich@example.com" }, "labels": { "direction": "north" }, "data": {}, "_doc": { "_primary_term": 88, "_seq_no": 66 } } ] }
The following request retrieves a subset of data
that’s nested under the
key app1
, along with the user’s profile:
GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0?data=app1.key1
{ "profiles": [ { "uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0", "enabled": true, "last_synchronized": 1642650651037, "user": { "username": "jacknich", "roles": [ "admin", "other_role1" ], "realm_name": "native", "full_name": "Jack Nicholson", "email": "jacknich@example.com" }, "labels": { "direction": "north" }, "data": { "app1": { "key1": "value1" } }, "_doc": { "_primary_term": 88, "_seq_no": 66 } } ] }
If there has been any errors when retrieving the user profiles, they are returned in the errors
field:
{ "profiles": [], "errors": { "count": 1, "details": { "u_FmxQt3gr1BBH5wpnz9HkouPj3Q710XkOgg1PWkwLPBW_5": { "type": "resource_not_found_exception", "reason": "profile document not found" } } } }