From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <pve-devel-bounces@lists.proxmox.com> Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 939711FF15E for <inbox@lore.proxmox.com>; Tue, 25 Mar 2025 17:38:29 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 11AA7F335; Tue, 25 Mar 2025 17:38:24 +0100 (CET) Date: Tue, 25 Mar 2025 17:37:49 +0100 (CET) From: Mira Limbeck <m.limbeck@proxmox.com> To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>, Thomas Skinner <thomas@atskinner.net> Message-ID: <913759433.2557.1742920669347@webmail.proxmox.com> In-Reply-To: <20250324023728.1294436-2-thomas@atskinner.net> References: <20250324023728.1294436-1-thomas@atskinner.net> <20250324023728.1294436-2-thomas@atskinner.net> MIME-Version: 1.0 X-Priority: 3 Importance: Normal X-Mailer: Open-Xchange Mailer v7.10.6-Rev74 X-Originating-Client: open-xchange-appsuite X-SPAM-LEVEL: Spam detection results: 0 AWL 0.287 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: Re: [pve-devel] [PATCH docs v4 1/1] fix #4411: openid: add docs for openid groups support X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com> List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe> List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/> List-Post: <mailto:pve-devel@lists.proxmox.com> List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help> List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe> Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com> Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com> > Thomas Skinner <thomas@atskinner.net> hat am 24.03.2025 03:37 CET geschrieben: > > > Signed-off-by: Thomas Skinner <thomas@atskinner.net> > --- > pveum.adoc | 37 +++++++++++++++++++++++++++++++++++++ > 1 file changed, 37 insertions(+) > > diff --git a/pveum.adoc b/pveum.adoc > index 81565ab..5da0e98 100644 > --- a/pveum.adoc > +++ b/pveum.adoc > @@ -456,6 +456,15 @@ use the `autocreate` option to automatically add new users. > * `Username Claim` (`username-claim`): OpenID claim used to generate the unique > username (`subject`, `username` or `email`). > > +* `Autocreate Groups` (`groups-autocreate`): Create all groups in the claim > +instead of using existing PVE groups (default behavior). > + > +* `Groups Claim` (`groups-claim`): OpenID claim used to retrieve the groups from > +the ID token or userinfo endpoint. > + > +* `Overwrite Groups` (`groups-overwrite`): Overwrite all groups assigned to user > +instead of appending to existing groups (default behavior). > + > Username mapping > ^^^^^^^^^^^^^^^^ > > @@ -479,6 +488,34 @@ Another option is to use `email`, which also yields human readable > usernames. Again, only use this setting if the server guarantees the > uniqueness of this attribute. > > +Groups mapping > +^^^^^^^^^^^^^^ > + > +Specifying the `groups-claim` setting in the OpenID configuration enables group > +mapping functionality. The data provided in the `groups-claim` should be > +a list of strings that correspond to groups that a user should be a member of in > +{pve}. To prevent collisions, group names from the OpenID claim are suffixed > +with `-<realm name>` (e.g. for the OpenID group name `my-openid-group` in the > +realm `oidc`, the group name in {pve} would be `my-openid-group-oidc`). > + > +Any groups reported by the OpenID provider that do not exist in {pve} are > +ignored by default. If all groups reported by the OpenID provider should exist > +in {pve}, the `groups-autocreate` option may be used to automatically create > +these groups on user logins. > + > +By default, groups are appended to the user's existing groups. It may be > +desirable to overwrite any groups that the user is already a member in {pve} > +with those from the OpenID provider. Enabling the `groups-overwrite` setting > +removes all groups from the user in {pve} before adding the groups reported by > +the OpenID provider. > + > +In some cases, OpenID servers may send groups claims which include invalid > +characters for {pve} group IDs. Any groups that contain characters not allowed > +in a {pve} group name are not included and a warning will be sent to the logs. > + > +Advanced settings > +^^^^^^^^^^^^^^^^^ These 2 lines need to be removed, otherwise xmllint fails validation. Maybe this could be fixed up when applying if there are no other issues with the patches? _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel