Get users | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

GET /_security/user

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

Query parameters

• Determines whether to retrieve the user profile UID, if it exists, for the users.

Responses

• 200 application/json
  Hide response attribute Show response attribute object
  • *
    object Additional properties
    Hide * attributes Show * attributes object
    * Hide metadata attribute Show metadata attribute object
    * *
    object Additional properties
    * roles
    array[string] Required

GET /_security/user

curl \
 --request GET 'http://api.example.com/_security/user' \
 --header "Authorization: $API_KEY"

Response examples (200)

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"
  }
}