Add SCIM endpoints (#2619)

rhysyngsun · web-flow · commit 880b79a987d2 · 2025-05-08T17:44:33.000-04:00
diff --git a/cms/api.py b/cms/api.py
@@ -255,7 +255,7 @@ def get_wagtail_img_src(image_obj) -> str:
 
 
 def create_default_courseware_page(
-    courseware: Union[Course, Program],  # noqa: FA100
+    courseware: Union[Course, Program],
     live: bool = False,  # noqa: FBT001, FBT002
     *args,  # noqa: ARG001
     **kwargs,  # noqa: ARG001
diff --git a/courses/management/commands/create_courseware.py b/courses/management/commands/create_courseware.py
@@ -21,7 +21,7 @@ class Command(BaseCommand):
 
     def _check_if_courseware_object_readable_id_exists(
         self,
-        courseware_object: Union[Course, Program],  # noqa: FA100
+        courseware_object: Union[Course, Program],
         courseware_id: str,
     ):
         """
@@ -44,7 +44,7 @@ def _check_if_courseware_object_readable_id_exists(
 
     def _add_departments_to_courseware_object(
         self,
-        courseware_object: Union[Course, Program],  # noqa: FA100
+        courseware_object: Union[Course, Program],
         departments: models.QuerySet,
     ):
         """
@@ -110,7 +110,7 @@ def _departments_do_not_exist_error(self):
 
     def _successfully_created_courseware_object_message(
         self,
-        courseware_object: Union[Course, Program],  # noqa: FA100
+        courseware_object: Union[Course, Program],
     ):
         """
         Outputs a success message to the console in the format of
diff --git a/courses/views/v1/__init__.py b/courses/views/v1/__init__.py
@@ -253,7 +253,7 @@ def get_serializer_context(self):
 
 def _validate_enrollment_post_request(
     request: Request,
-) -> Union[Tuple[Optional[HttpResponse], None, None], Tuple[None, User, CourseRun]]:  # noqa: FA100, UP006
+) -> Union[Tuple[Optional[HttpResponse], None, None], Tuple[None, User, CourseRun]]:  # noqa: UP006
     """
     Validates a request to create an enrollment. Returns a response if validation fails, or a user and course run
     if validation succeeds.
diff --git a/flexiblepricing/api.py b/flexiblepricing/api.py
@@ -363,7 +363,7 @@ def update_currency_exchange_rate(rates, currency_descriptions):
 
 
 def create_default_flexible_pricing_page(
-    object: Union[Course, Program],  # noqa: A002, FA100
+    object: Union[Course, Program],  # noqa: A002
     forceCourse: bool = False,  # noqa: FBT001, FBT002
     *args,  # noqa: ARG001
     **kwargs,
diff --git a/main/exceptions.py b/main/exceptions.py
@@ -6,7 +6,7 @@
 def exception_handler(exc, context):
     """Override DRF exception_handler to slightly change format of error response"""
     if isinstance(exc, exceptions.ValidationError) and isinstance(
-        exc.detail, (list, dict)
+        exc.detail, list | dict
     ):
         exc = exceptions.ValidationError(
             detail={"errors": exc.detail}, code=exc.status_code
diff --git a/main/settings.py b/main/settings.py
@@ -25,6 +25,7 @@
 from mitol.google_sheets.settings.google_sheets import *  # noqa: F403
 from mitol.google_sheets_deferrals.settings.google_sheets_deferrals import *  # noqa: F403
 from mitol.google_sheets_refunds.settings.google_sheets_refunds import *  # noqa: F403
+from mitol.scim.settings.scim import *  # noqa: F403
 from redbeat import RedBeatScheduler
 
 from main.celery_utils import OffsettingSchedule
@@ -214,6 +215,7 @@
     "mitol.authentication.apps.TransitionalAuthenticationApp",
     "mitol.payment_gateway.apps.PaymentGatewayApp",
     "mitol.olposthog.apps.OlPosthog",
+    "mitol.scim.apps.ScimApp",
     # "mitol.oauth_toolkit_extensions.apps.OAuthToolkitExtensionsApp",
     "viewflow",
     "openapi",
@@ -495,7 +497,10 @@
 ]
 for name, path in [
     ("mitx-online", os.path.join(BASE_DIR, "frontend/public/build")),  # noqa: PTH118
-    ("staff-dashboard", os.path.join(BASE_DIR, "frontend/staff-dashboard/build")),  # noqa: PTH118
+    (
+        "staff-dashboard",
+        os.path.join(BASE_DIR, "frontend/staff-dashboard/build"),  # noqa: PTH118
+    ),
 ]:
     if os.path.exists(path):  # noqa: PTH110
         STATICFILES_DIRS.append((name, path))
@@ -994,6 +999,8 @@
     ),
 }
 
+SCIM_SERVICE_PROVIDER["USER_ADAPTER"] = "users.adapters.LearnUserAdapter"  # noqa: F405
+
 
 # DRF configuration
 REST_FRAMEWORK = {
diff --git a/main/test_utils.py b/main/test_utils.py
@@ -54,7 +54,7 @@ class MockResponse:
     def __init__(
         self, content, status_code=200, content_type="application/json", url=None
     ):
-        if isinstance(content, (dict, list)):
+        if isinstance(content, dict | list):
             self.content = json.dumps(content)
         else:
             self.content = str(content)
diff --git a/main/urls.py b/main/urls.py
@@ -49,6 +49,7 @@
     path("", include("flexiblepricing.urls")),
     path("", include("mitol.google_sheets.urls")),
     path("", include("b2b.urls")),
+    re_path(r"", include("mitol.scim.urls")),
     re_path(r"^dashboard/", index, name="user-dashboard"),
     # social django needs to be here to preempt the login
     path("", include("social_django.urls", namespace="social")),
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -71,6 +71,8 @@ drf-spectacular = "^0.28.0"
 wagtail = "6.3"
 mitol-django-apigateway = "^2025.4.25.1"
 rich = "^14.0.0"
+pyparsing = "^3.2"
+mitol-django-scim = "^2025.3.31"
 
 
 [tool.poetry.group.dev.dependencies]
@@ -98,7 +100,7 @@ wagtail-factories = "^4.2"
 pytest-xdist = {extras = ["psutil"], version = "^3.6.1"}
 
 [tool.ruff]
-target-version = "py39"
+target-version = "py310"
 line-length = 88
 
 [tool.ruff.lint]
diff --git a/users/adapters.py b/users/adapters.py
@@ -0,0 +1,84 @@
+from typing import TYPE_CHECKING
+
+from mitol.scim.adapters import UserAdapter
+
+from openedx.models import OpenEdxUser
+from users.models import LegalAddress, UserProfile
+
+if TYPE_CHECKING:
+    from users.models import User
+
+
+class LearnUserAdapter(UserAdapter):
+    """
+    Custom adapter to extend django_scim library.  This is required in order
+    to extend the profiles.models.Profile model to work with the
+    django_scim library.
+    """
+
+    ATTR_MAP = UserAdapter.ATTR_MAP | {
+        ("fullName", None, None): "name",
+    }
+
+    obj: "User"
+
+    user_profile: UserProfile
+    legal_address: LegalAddress
+    openedx_user: OpenEdxUser
+
+    def __init__(self, obj, request=None):
+        super().__init__(obj, request=request)
+
+        self.user_profile = self.obj.user_profile = getattr(
+            self.obj, "user_profile", UserProfile()
+        )
+
+        self.legal_address = self.obj.legal_address = getattr(
+            self.obj, "legal_address", LegalAddress()
+        )
+
+        self.openedx_user = self.obj.openedx_user
+        if self.openedx_user is None:
+            del self.obj.openedx_user
+            self.openedx_user = self.obj.openedx_user = OpenEdxUser()
+
+    @property
+    def display_name(self):
+        """
+        Return the displayName of the user per the SCIM spec.
+        """
+        return self.obj.name
+
+    def from_dict(self, d):
+        """
+        Consume a ``dict`` conforming to the SCIM User Schema, updating the
+        internal user object with data from the ``dict``.
+
+        Please note, the user object is not saved within this method. To
+        persist the changes made by this method, please call ``.save()`` on the
+        adapter. Eg::
+
+            scim_user.from_dict(d)
+            scim_user.save()
+        """
+        super().from_dict(d)
+
+        self.obj.name = d.get("fullName", "")
+
+        first_name = d.get("name", {}).get("given_name", "")
+        if first_name:
+            self.legal_address.first_name = first_name
+
+        last_name = d.get("name", {}).get("last_name", "")
+        if last_name:
+            self.legal_address.last_name = last_name
+
+    def _save_related(self):
+        self.user_profile.user = self.obj
+        self.user_profile.save()
+
+        self.legal_address.user = self.obj
+        self.legal_address.save()
+
+        self.openedx_user.user = self.obj
+        self.openedx_user.save()
diff --git a/users/migrations/0028_add_user_scim_fields.py b/users/migrations/0028_add_user_scim_fields.py
@@ -0,0 +1,51 @@
+# Generated by Django 4.2.20 on 2025-03-31 14:37
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("users", "0027_alter_user_username"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="user",
+            name="scim_external_id",
+            field=models.CharField(
+                blank=True,
+                db_index=True,
+                default=None,
+                help_text="A string that is an identifier for the resource as defined by the provisioning client.",
+                max_length=254,
+                null=True,
+                verbose_name="SCIM External ID",
+            ),
+        ),
+        migrations.AddField(
+            model_name="user",
+            name="scim_id",
+            field=models.CharField(
+                blank=True,
+                default=None,
+                help_text="A unique identifier for a SCIM resource as defined by the service provider.",
+                max_length=254,
+                null=True,
+                unique=True,
+                verbose_name="SCIM ID",
+            ),
+        ),
+        migrations.AddField(
+            model_name="user",
+            name="scim_username",
+            field=models.CharField(
+                blank=True,
+                db_index=True,
+                default=None,
+                help_text="A service provider's unique identifier for the user",
+                max_length=254,
+                null=True,
+                verbose_name="SCIM Username",
+            ),
+        ),
+    ]
diff --git a/users/models.py b/users/models.py
