opensearch-project / opensearch-project/security

[Documentation Update] opendistro_security_roles is supported for opendistro-1.3.0+ versions

Open
#3,757 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug triaged
Dominant language
Java
Stars
252
Forks
395
Avg merge
1d 11h
Merged PRs (30d)
76

Description

What is the bug?
Confusing documentation around opendistro_security_roles field while creating Internal users via API, which provide respective permissions to the user without explicit roles mapping.

Note that any role you supply in the opendistro_security_roles array must already exist for the Security plugin to map the user to that role. To see predefined roles, refer to the list of predefined roles. For instructions on how to create a role, refer to creating a role.

But opendistro_security_roles support was added for ES-7.3+ version commit.

What is the expected behavior?
Documentation should be updated saying opendistro_security_roles is supported from opendistro-1.3.0+ versions.

What is your host/environment?

  • OS: [Linux]
  • Version [Elasticsearch-6.8, opendisto-0.10.0]
  • Plugins [Security]

Do you have any screenshots?
NA

Do you have any additional context?
NA

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the linked Create User API documentation and review its note alongside the linked predefined-roles and create-role sections. Update the note to state that opendistro_security_roles is supported for opendistro-1.3.0+ versions, then verify the wording and links in the rendered documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch
Domain
authorization, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.