Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document which APIs are affected by which role pivileges #37538

Erni opened this issue Jan 16, 2019 · 3 comments


None yet
4 participants
Copy link

commented Jan 16, 2019

Currently our documentation states the Cluster andIndices privileges that you can set to your roles:

That´s fine but there are many users not knowing the actual requests a particular privilege allows to do.
For example imagine the manage_index_templates privilege. Its description says All operations on index templates. However many users might be confuser not being allowed to execute the _cat/templates API call with this privilege.
So there´s clearly a need to specify the APIs and actions that every privilege involves.


This comment has been minimized.

Copy link

commented Jan 16, 2019

@tvernum tvernum self-assigned this May 9, 2019

@tvernum tvernum removed the team-discuss label May 9, 2019


This comment has been minimized.

Copy link

commented May 9, 2019

We've discussed this (a few times).

Actually documenting which privileges are required by each Rest API is an impossible task. The API changes rapidly enough that the documentation simply can't keep up - and the way Elasticsearch works with plugins means that it's not something that is easy to generate automatically.

There are 2 things we think we can do:

  1. Make some general improvements to the privileges pages. They've been around for a while, and haven't seen a lot of love in the last few years. We can definitely document some of those privileges more clearly so that it is more obvious what they are intended to allow.
  2. Make the "permission denied" error more explicit & actionable. At the moment you get something like "user [xyz] is not permitted to perform action [cluster:foo/bar]" which is factually correct, but not of a lot of use to the person who it trying to setup roles for their needs. We can do better here.

I'm going to raise issues for each of those, at which point I will close this issue.


This comment has been minimized.

Copy link

commented May 16, 2019

I raised

@tvernum tvernum closed this May 16, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.