Refactor data structures in spar related to user-identifying information

cassandra-schema.cql

@@ -681,6 +681,11 @@ CREATE TABLE brig_test.user (
     phone text,
     picture list<blob>,
     provider uuid,
+    saml_entity_id text,
+    saml_name_id text,
+    scim_external_id text,
+    scim_email text,
+    scim_email_source text,
     searchable boolean,
     service uuid,
     sso_id text,

changelog.d/3-bug-fixes/WPB-1583

@@ -0,0 +1,3 @@
+[WIP]
+
+- fixed bug with scim update and ??

changelog.d/5-internal/WPB-1583

@@ -0,0 +1,5 @@
+[WIP]
+
+- useridentity has new field uauth_id that contains consistent and complete user-identifying info from spar.
+- related parsers has more error cases now.
+- managed_by is not a database field any more.

libs/brig-types/src/Brig/Types/User/Event.hs

@@ -81,7 +81,7 @@ data UserUpdatedData = UserUpdatedData
     eupHandle :: !(Maybe Handle),
     eupLocale :: !(Maybe Locale),
     eupManagedBy :: !(Maybe ManagedBy),
-    eupSSOId :: !(Maybe UserSSOId),
+    eupSSOId :: !(Maybe LegacyUserSSOId), -- TODO: add fields `eupUAuthId`?  (this can replace both SSOId and SSOIdRemoved, but beware of backward compatibility issues when removing those!)
     eupSSOIdRemoved :: Bool,
     eupSupportedProtocols :: !(Maybe (Set BaseProtocolTag))
   }

libs/brig-types/test/unit/Test/Brig/Types/User.hs

@@ -37,6 +37,7 @@ import Test.Tasty
 import Test.Tasty.HUnit
 import Wire.API.Routes.Internal.Brig.EJPD (EJPDRequestBody (..), EJPDResponseBody (..))
 import Wire.API.User.Auth.ReAuth
+import Wire.API.User.Test
 
 tests :: TestTree
 tests = testGroup "User (types vs. aeson)" $ roundtripTests
@@ -51,14 +52,17 @@ roundtripTests =
     testRoundTripWithSwagger @EJPDResponseBody,
     testRoundTrip @UpdateConnectionsInternal,
     testRoundTrip @SearchVisibilityInbound,
-    testRoundTripWithSwagger @UserAccount,
+    testRoundTripWithSwagger @(WithSanitizedUserIdentity UserAccount),
     testGroup "golden tests" $
       [testCaseUserAccount]
   ]
 
 instance Arbitrary ReAuthUser where
   arbitrary = ReAuthUser <$> arbitrary <*> arbitrary <*> arbitrary
 
+instance Arbitrary (WithSanitizedUserIdentity UserAccount) where
+  arbitrary = (arbitrary >>= coherenizeUserAccount) <&> WithSanitizedUserIdentity
+
 testCaseUserAccount :: TestTree
 testCaseUserAccount = testCase "UserAcccount" $ do
   assertEqual "1" (Just json1) (encode <$> decode @UserAccount json1)

libs/wire-api/default.nix

@@ -225,6 +225,7 @@ mkDerivation {
     hex
     hspec
     hspec-wai
+    http-api-data
     http-types
     imports
     iso3166-country-codes

libs/wire-api/src/Wire/API/Deprecated.hs

@@ -30,6 +30,8 @@ import Servant.Client
 import Servant.OpenApi
 
 -- Annotate that the route is deprecated
+--
+-- FUTUREWORK: give this a message string that explains how to migrate away from the deprecated end-point!
 data Deprecated deriving (Typeable)
 
 -- All of these instances are very similar to the instances

libs/wire-api/src/Wire/API/Routes/Internal/Brig.hs

@@ -62,6 +62,7 @@ import Servant.OpenApi (HasOpenApi (toOpenApi))
 import Servant.OpenApi.Internal.Orphans ()
 import Util.Options
 import Wire.API.Connection
+import Wire.API.Deprecated
 import Wire.API.Error
 import Wire.API.Error.Brig
 import Wire.API.MLS.CipherSuite
@@ -347,10 +348,11 @@ type AccountAPI =
            )
     :<|> Named
            "iPutUserSsoId"
-           ( "users"
+           ( Deprecated -- use `iPutUAuthId` instead
+               :> "users"
                :> Capture "uid" UserId
                :> "sso-id"
-               :> ReqBody '[Servant.JSON] UserSSOId
+               :> ReqBody '[Servant.JSON] LegacyUserSSOId
                :> MultiVerb
                     'PUT
                     '[Servant.JSON]
@@ -361,7 +363,8 @@ type AccountAPI =
            )
     :<|> Named
            "iDeleteUserSsoId"
-           ( "users"
+           ( Deprecated -- use `iDeleteUAuthId` instead
+               :> "users"
                :> Capture "uid" UserId
                :> "sso-id"
                :> MultiVerb
@@ -372,6 +375,33 @@ type AccountAPI =
                      ]
                     UpdateSSOIdResponse
            )
+    :<|> Named
+           "iPutUAuthId"
+           ( "users"
+               :> Capture "uid" UserId
+               :> "uauthid"
+               :> ReqBody '[Servant.JSON] PartialUAuthId
+               :> MultiVerb
+                    'PUT
+                    '[Servant.JSON]
+                    '[ RespondEmpty 200 "UpdateSSOIdSuccess",
+                       RespondEmpty 404 "UpdateSSOIdNotFound"
+                     ]
+                    UpdateSSOIdResponse
+           )
+    :<|> Named
+           "iDeleteUAuthId"
+           ( "users"
+               :> Capture "uid" UserId
+               :> "uauthid"
+               :> MultiVerb
+                    'DELETE
+                    '[Servant.JSON]
+                    '[ RespondEmpty 200 "UpdateSSOIdSuccess",
+                       RespondEmpty 404 "UpdateSSOIdNotFound"
+                     ]
+                    UpdateSSOIdResponse
+           )
     :<|> Named
            "iPutManagedBy"
            ( "users"