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

Allow roles to have an optional description #173570

Closed
legrego opened this issue Dec 18, 2023 · 2 comments · Fixed by #183145
Closed

Allow roles to have an optional description #173570

legrego opened this issue Dec 18, 2023 · 2 comments · Fixed by #183145
Assignees
Labels
enhancement New value added to drive a business result Feature:Users/Roles/API Keys Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more!

Comments

@legrego
Copy link
Member

legrego commented Dec 18, 2023

Role names do not always convey the purpose or scope of a role. In order to improve the administrative experience, we should allow roles to have an optional description.

Role descriptions are available in both the stateful and serverless offering. The requirements do not differ between these distribution types.

Requirements

  • The Create Role UI should allow a role to be created with a description.
  • The Create Role API should allow a role to be created with a description.
  • Role descriptions should be updatable via both UI and API.
  • Validation for the length and content of descriptions shall be handled by ES, with errors returned to the UI/API appropriately.
  • The Role Listing Page should display the description of each role, truncated if necessary.
  • The Get Role API should include the description in its response
  • API documentation should be updated accordingly
  • API changes must be backwards-compatible. A role should be creatable/updatable without a description.
  • The roles combo box that we render on the User and Role Mappings page should be updated to include the description in some capacity (e.g. tooltip or similar)

Mockup:

Image

Changes from mockup:

  • Remove the field description which states This description will be visible when assigning roles from the Organization page.
@legrego legrego added Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more! Feature:Users/Roles/API Keys labels Dec 18, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-security (Team:Security)

@legrego
Copy link
Member Author

legrego commented May 8, 2024

This is unblocked now that elastic/elasticsearch#107088 has merged.

@legrego legrego added the enhancement New value added to drive a business result label May 8, 2024
@elena-shostak elena-shostak self-assigned this May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New value added to drive a business result Feature:Users/Roles/API Keys Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants