Docs
Elasticsearch Guide [8.1] » REST APIs » Security APIs » Get users API
« Get user privileges API Grant API key API »

Get users API

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

Request

GET /_security/user

GET /_security/user/<username>

Prerequisites

  • To use this API, you must have at least the manage_security cluster privilege.

Description

For more information about the native realm, see Realms and Native user authentication.

Path parameters

username
(Optional, string) 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.

Response body

A successful call returns an array of users with the JSON representation of the users. Note that user passwords are not included.

Response codes

If the user is not defined in the native realm, the request 404s.

Examples

To retrieve a native user, submit a GET request to the /_security/user/<username> endpoint:

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

Omit the username to retrieve all users:

GET /_security/user
« Get user privileges API Grant API key API »