Skip to content

Commit de467cb

Browse files
appleboyclaude
andcommitted
docs(groups): correct claim-key configurability and deny-list wording
- Note in the group form that the emitted claim key defaults to groups and is configurable via OIDC_GROUPS_CLAIM_NAME - Clarify in .env.example and docs/GROUPS.md that the system: deny-list is applied to both the raw name and the prefixed value, not only before prefixing Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 6a56de3 commit de467cb

3 files changed

Lines changed: 8 additions & 5 deletions

File tree

.env.example

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,9 @@ SESSION_SECRET=session-secret-change-in-production
8888
# OIDC_GROUPS_CLAIM_NAME=groups # Example: OIDC_GROUPS_CLAIM_NAME=roles
8989
#
9090
# OIDC_GROUPS_PREFIX — optional string prepended to every emitted group name
91-
# (e.g. "oidc:"). Default empty. Applied before the system: deny-list, so a
92-
# prefix that produces a system: value is still dropped.
91+
# (e.g. "oidc:"). Default empty. The system: deny-list is applied to BOTH the
92+
# raw name and the prefixed value, so a name or a prefix that resolves to a
93+
# system: value is always dropped.
9394
# OIDC_GROUPS_PREFIX= # Example: OIDC_GROUPS_PREFIX=oidc:
9495

9596
# JWT Token Expiration

docs/GROUPS.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,9 @@ until an admin adds the scope.
4747

4848
Both emission sites (id_token and `/oauth/userinfo`) resolve the claim key and
4949
prefix from the same config and run names through the same
50-
`services.BuildGroupsClaim` transform (deny-list → prefix → de-dup → sort), so
51-
the two views are always identical.
50+
`services.BuildGroupsClaim` transform — the `system:` deny-list is applied both
51+
before and after prefixing, then the optional prefix, de-dup, and sort — so the
52+
two views are always identical.
5253

5354
## Managing groups
5455

internal/templates/admin_group_form.templ

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ templ AdminGroupForm(props GroupFormPageProps) {
3232
<div class="admin-form-header">
3333
<h1 class="admin-form-title">{ groupFormTitle(props) }</h1>
3434
<p class="admin-form-subtitle">
35-
The group name is emitted in the OIDC <code>groups</code> claim for members.
35+
The group name is emitted in the OIDC groups claim for members
36+
(default key <code>groups</code>, configurable via <code>OIDC_GROUPS_CLAIM_NAME</code>).
3637
Names starting with <code>system:</code> are not allowed.
3738
</p>
3839
</div>

0 commit comments

Comments
 (0)