Get users

GET /_security/user/{username}
GET /_security/user

Auth

Get information about users in the native realm and built-in users.

Required authorization

Cluster privileges read_security

Path parameters

username union string | string[] optional

An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users.

Leave it out to use /_security/user.

Query parameters

with_profile_uid boolean · default: false: Determines whether to retrieve the user profile UID, if it exists, for the users.

Response

application/json

<string> object

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_security/user/jacknich?with_profile_uid=true

JavaScript Elasticsearch JavaScript Client

const response = await client.security.getUser({
  username: "jacknich",
  with_profile_uid: "true",
});

Python Elasticsearch Python Client

resp = client.security.get_user(
    username="jacknich",
    with_profile_uid=True,
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_security/user/jacknich?with_profile_uid=true" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().getUser(g -> g
    .username("jacknich")
    .withProfileUid(true)
);

C# Elasticsearch .NET Client

var response = await client.Security
    .GetUserAsync(d1 => d1
        .Username(["jacknich"])
        .WithProfileUid(true)
    );

PHP Elasticsearch PHP Client

$resp = $client->security()->getUser([
    "username" => "jacknich",
    "with_profile_uid" => "true",
]);

Ruby Elasticsearch Ruby Client

response = client.security.get_user(
  username: "jacknich",
  with_profile_uid: "true"
)

Response

A successful response from GET /_security/user/jacknich?with_profile_uid=true. It includes the user profile_uid as part of the response.

{
  "jacknich": {
    "username": "jacknich",
    "roles": [
      "admin", "other_role1"
    ],
    "full_name": "Jack Nicholson",
    "email": "jacknich@example.com",
    "metadata": { "intelligence" : 7 },
    "enabled": true,
    "profile_uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0"
  }
}