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

Keycloak group and role names #110

Open
Mtze opened this issue Jan 27, 2025 · 1 comment · May be fixed by #124
Open

Keycloak group and role names #110

Mtze opened this issue Jan 27, 2025 · 1 comment · May be fixed by #124
Assignees
Labels
Component: Core Issues related to the prompt core Component: Keycloak enhancement New feature or request

Comments

@Mtze
Copy link
Member

Mtze commented Jan 27, 2025

The current prompt creates Keycloak groups with the following naming scheme:

<Course name>-<Semester tag>

It also creates three subgroups:

<Course name>-<Semester tag>-Student
<Course name>-<Semester tag>-Lecturer
<Course name>-<Semester tag>-Editor

The general structure is great, but there are a few areas where the naming could be improved.

  1. It’s hard to tell which groups were created manually and which were created by the prompt in Keycloak.
  2. The semester tag isn’t grouped together, since it’s a suffix instead of a prefix.
  3. The subgroup names are quite long.

I’ve come up with a suggestion (up for discussion):

  • We can create a top-level group in Keycloak that all the other prompt-created groups are sorted into.
  • The course group name can be formed the other way around: <Semester tag>-<Course name>.
  • The Lecturer, Student, and Editor groups can be subgroups of the course group without the course name in the group name.
- prompt
| - ss25-fancy-course
|  | - Lecturer
|  | - Editor  
|  | - Student
| - ss25-fancy-second-course
|  | - Lecturer
|  | - Editor  
|  | - Student

The roles for prompt should also follow this convention - even without the tree structure - so <semester tag>-<course-name>-<role>

What do you think?

@Mtze Mtze added enhancement New feature or request Component: Core Issues related to the prompt core Component: Keycloak labels Jan 27, 2025
@niclasheun
Copy link
Contributor

Two thoughts to that:

  • For the roles, it is crucial to keep the course name included. So we would not have a 1:1 mapping between role name and group name any more (which is fine I guess)
  • When I implemented it, I researched and thought that keycloak has only 1 level of subgrouping. So nesting all prompt groups in a top level prompt group is (to my understanding) not possible.

@Mtze Mtze added this to PROMPT Jan 27, 2025
@Mtze Mtze moved this to Todo in PROMPT Jan 27, 2025
@Mtze Mtze moved this from Todo to In Progress in PROMPT Jan 27, 2025
@niclasheun niclasheun self-assigned this Jan 29, 2025
@niclasheun niclasheun linked a pull request Jan 29, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Core Issues related to the prompt core Component: Keycloak enhancement New feature or request
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

2 participants