Update user profile data

POST also PUT /_security/profile/{uid}/_data

Update specific data for the user profile that is associated with a unique 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.

To use this API, you must have one of the following privileges:

The manage_user_profile cluster privilege.
The update_profile_data global privilege for the namespaces that are referenced in the request.

This API updates the labels and data fields of an existing user profile document with JSON objects. New keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.

For both labels and data, content is namespaced by the top-level fields. The update_profile_data global privilege grants privileges for updating only the allowed namespaces.

Required authorization

Cluster privileges: manage_user_profile

Path Parameters

uid string required: A unique identifier for the user profile.

Run POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data to update a profile document for the u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0 user profile.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data
{
  "labels": {
    "direction": "east"
  },
  "data": {
    "app1": {
      "theme": "default"
    }
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.security.updateUserProfileData({
  uid: "u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0",
  labels: {
    direction: "east",
  },
  data: {
    app1: {
      theme: "default",
    },
  },
});

Python Elasticsearch Python Client

resp = client.security.update_user_profile_data(
    uid="u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0",
    labels={
        "direction": "east"
    },
    data={
        "app1": {
            "theme": "default"
        }
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "labels": {
      "direction": "east"
    },
    "data": {
      "app1": {
        "theme": "default"
      }
    }
  }'

Java Elasticsearch Java Client

client.security().updateUserProfileData(u -> u
    .data("app1", JsonData.fromJson("{\"theme\":\"default\"}"))
    .labels("direction", JsonData.fromJson("\"east\""))
    .uid("u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0")
);

C# Elasticsearch .NET Client

var response = await client.Security
    .UpdateUserProfileDataAsync(uid: "u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0", d1 => d1
        .Data(new Dictionary<string, object>()
        {
            { "app1", JsonSerializer.Deserialize<JsonElement>("""
            {
              "theme": "default"
            }
            """) }
        })
        .Labels(new Dictionary<string, object>()
        {
            { "direction", "east" }
        })
    );

PHP Elasticsearch PHP Client

$resp = $client->security()->updateUserProfileData([
    "uid" => "u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0",
    "body" => [
        "labels" => [
            "direction" => "east",
        ],
        "data" => [
            "app1" => [
                "theme" => "default",
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.security.update_user_profile_data(
  uid: "u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0",
  body: {
    "labels": {
      "direction": "east"
    },
    "data": {
      "app1": {
        "theme": "default"
      }
    }
  }
)

Response

{
  "acknowledged": true
}

Required authorization

Path Parameters

Query Parameters { if_seq_no , if_primary_term , refresh , }

Request { labels , data , }

Response

Query Parameters

Request