keycloak/keycloak

Enable description for groups

Open

#21,190 opened on Jun 24, 2023

View on GitHub
 (4 comments) (5 reactions) (1 assignee)Java (8,346 forks)batch import
area/admin/uiarea/storagehelp wantedkind/featureteam/core-iam

Repository metrics

Stars
 (34,398 stars)
PR merge metrics
 (Avg merge 6d 19h) (384 merged PRs in 30d)

Description

Description

It would be helpful if it were possible to allow description for groups.

Discussion

No response

Motivation

If you have a large group structure with many groups, it may not be immediately obvious what a group is for.

For example: A group is used to describe an activity, then all the roles required for this activity are assigned to the group. If the activity is more complex, it may not be possible to describe it in one word. Therefore, a description would be very helpful.

Details

The description of the group should appear once when you click on the group. You could also use a tooltip or hover over the group name to display the description directly.

Contributor guide

Research direction
Examine the GroupModel interface and GroupRepresentation DTO to add a description field. Update the admin console REST API to include description when creating/updating groups. Then modify the admin console UI (likely Angular) to show the description in the group list and details.
Tech stack
java
Domain
backendauthenticationsecurity
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaKeycloak basicsGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50