Type to search.

Get users

  • GET /_security/user/{username}
  • GET /_security/user
Auth

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

Required privileges

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 The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 8.5 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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

Response

application/json