Clarify File-based grants are not visible with API calls
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- api, authorization, documentation
Research direction
Start with the defining-roles and mapping-roles documentation pages linked in the issue, then compare their descriptions with the provided API examples. Clarify that users, roles, and mappings defined in files or through the users CLI are not reported by the corresponding management APIs, and verify the updated wording against both examples.
Written by the indexing model from the issue text.
Description
The following is true of all versions: The APIs (user, role, role mapping) only work with objects that were defined via the API.
Objects (users, roles, mappings) defined in files need to be managed via the files (or the users CLI tool which uses the files).
API exploration calls (and consecutively, Kibana) will not report roles and mappings defined in files.
Example, where role production_user is defined in roles.yml and user "test" is a file realm user created with the users CLI tool.
curl -X GET -u test:password http://localhost:9200/_xpack/security/_authenticate
{"username":"test","roles":["production_user"],"full_name":null,"email":null,"metadata":{},"enabled":true}[root@localhost x-pack]#
curl -X GET -u test:password http://localhost:9200/_xpack/security/role/production_user
{}
curl -X GET -u elastic:password http://localhost:9200/_xpack/security/user/test
{}
Some places to update docs to reflect this behavior:
https://www.elastic.co/guide/en/elastic-stack-overview/6.6/defining-roles.html#roles-management-file
https://www.elastic.co/guide/en/elastic-stack-overview/6.6/mapping-roles.html#mapping-roles-file
- Dominant language
- Java
- Stars
- 105
- Forks
- 249
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from elastic/stack-docs
-
Difficulty 1/5 Under an hour Newbie friendliness 35/100
elastic/stack-docs#2749 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
elastic/stack-docs#2395 ·
-
discussion help wanted
Difficulty 5/5 Over a week Newbie friendliness 25/100
elastic/stack-docs#2291 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
elastic/stack-docs#2263 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
elastic/stack-docs#2224 ·
All issues in elastic/stack-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
elastic/gradle-plugins#157 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
cryptomator/hub#497 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
johanhaleby/occurrent#1120 ·