[ENG-10635] Update API to support querying institutions for all active and (SSO Availability) public institutions

api/institutions/views.py

@@ -88,7 +88,9 @@ class InstitutionList(JSONAPIBaseView, generics.ListAPIView, ListFilterMixin):
     ordering = ('name',)
 
     def get_default_queryset(self):
-        return Institution.objects.filter(_id__isnull=False, is_deleted=False)
+        if 'filter[sso_availability]' in self.request.query_params:
+            return Institution.objects.filter(_id__isnull=False, is_deleted=False)
+        return Institution.objects.get_non_hidden_institutions().filter(_id__isnull=False, is_deleted=False)
 
     # overrides ListAPIView
     def get_queryset(self):

api_tests/institutions/views/test_institution_list.py

@@ -80,3 +80,24 @@ def test_sso_availability_filter(
         assert institution_one._id in ids
         assert institution_three._id in ids
         assert institution_two._id not in ids
+
+    def test_default_filter_excludes_institutions_with_sso_availability_hidden(
+            self, app, institution_one, institution_two, institution_three, url_institution
+    ):
+        institution_one.sso_availability = 'Unavailable'
+        institution_one.save()
+
+        institution_two.sso_availability = 'Public'
+        institution_two.save()
+
+        institution_three.sso_availability = 'Hidden'
+        institution_three.save()
+
+        res = app.get(url_institution)
+        assert res.status_code == 200
+
+        ids = [each['id'] for each in res.json['data']]
+        assert len(res.json['data']) == 2
+        assert institution_one._id in ids
+        assert institution_two._id in ids
+        assert institution_three._id not in ids

osf/models/institution.py

@@ -63,6 +63,9 @@ def get_queryset(self):
     def get_all_institutions(self):
         return super().get_queryset()
 
+    def get_non_hidden_institutions(self):
+        return super().get_queryset().filter(deactivated__isnull=True, sso_availability__in=[SSOAvailability.PUBLIC.value, SSOAvailability.UNAVAILABLE.value])
+
 
 class Institution(DirtyFieldsMixin, Loggable, ObjectIDMixin, BaseModel, GuardianMixin):
     objects = InstitutionManager()

osf_tests/factories.py

@@ -28,6 +28,7 @@
 from osf import models
 from osf.models.sanctions import Sanction
 from osf.models.storage import PROVIDER_ASSET_NAME_CHOICES
+from osf.models.institution import SSOAvailability
 from osf.utils.names import impute_names_model
 from osf.utils.workflows import (
     DefaultStates,
@@ -258,6 +259,7 @@ class InstitutionFactory(DjangoModelFactory):
     orcid_record_verified_source = ''
     delegation_protocol = ''
     institutional_request_access_enabled = False
+    sso_availability = SSOAvailability.PUBLIC.value
 
     class Meta:
         model = models.Institution