Merge pull request #12 from coreweave/scim-posix-groupname

feat: Add custom groupname selection for SCIM

Author: cmisale

examples/nsscache-scim.conf

@@ -92,6 +92,7 @@ scim_path_username = urn:example:params:scim:schemas:extension:User/userName
 
 scim_path_username = urn:example:params:scim:schemas:extension:User/userName
 scim_path_gid = urn:example:params:scim:schemas:extension:User/groupId
+scim_path_groupname = CustomGroupName
 
 ##
 # Cache configuration - use local directory for testing

nss_cache/sources/scimsource.py

@@ -631,10 +631,8 @@ def __init__(self, source=None):
     def _ReadEntry(self, group_data):
         """Return a GroupMapEntry from a SCIM group resource."""
 
-        # Use displayName or fallback to other name fields
-        group_name = (group_data.get("displayName") or
-                     group_data.get("name") or
-                     group_data.get("id"))
+        # Extract group name using configurable path
+        group_name = self._ExtractGroupName(group_data)
 
         if not group_name:
             self.log.warning("SCIM group missing name, skipping")
@@ -657,6 +655,21 @@ def _ReadEntry(self, group_data):
 
         return map_entry
 
+    def _ExtractGroupName(self, group_data):
+        """Extract group name using configurable path."""
+        groupname_path = self._GetMapConfig("scim_path_groupname", "")
+
+        # Try the configured path first
+        if groupname_path:
+            name = self._ExtractFromPath(group_data, groupname_path)
+            if name:
+                return name
+
+        # Fallback to standard SCIM name fields
+        return (group_data.get("displayName") or
+                group_data.get("name") or
+                group_data.get("id"))
+
     def _ExtractGroupGid(self, group_data):
         """Extract GID from SCIM group data using configurable path."""
         gid_path = self._GetMapConfig("scim_path_gid", "")

nsscache.conf.5

@@ -423,6 +423,13 @@ Path within SCIM user resources to extract the user ID (UID). Defaults to
 .B scim_path_gid
 Path within SCIM user/group resources to extract the group ID (GID).
 
+.TP
+.B scim_path_groupname
+Path within SCIM group resources to extract the preferred group name. This can be
+used when the SCIM server provides a custom field for group names.
+If not specified or the path returns no value, nsscache will fall
+back to using displayName, name, or id from the SCIM group resource.
+
 .TP
 .B scim_path_home_directory
 Path within SCIM user resources to extract the home directory. If not specified,