feat: add pseudocode for user endpoints

Author: chrisarridge

src/register_your_data_api/routers/users.py

@@ -15,6 +15,13 @@ def add_user_to_reporting_org(
     request: starlette.requests.Request,
     user: authn.UserAndCredentials = Security(authn.parse_decoded_token, scopes=["ryd", "ryd:reporting_org:user"]),
 ) -> JSONResponse:
+    # check token has required scopes
+    # check roles
+    # get user ID from the access token
+    # make sure user exists in CRM and identity service
+    # make sure reporting org exists
+    # find user in CRM and add relationship
+    # write fga token to identity service
     raise fastapi.HTTPException(
         status_code=fastapi.status.HTTP_501_NOT_IMPLEMENTED,
         detail="Not yet implemented",
@@ -28,6 +35,15 @@ def update_user_role_in_reporting_org(
         authn.parse_decoded_token, scopes=["ryd", "ryd:reporting_org:user:update"]
     ),
 ) -> JSONResponse:
+    # check token has required scopes
+    # check roles
+    # get user ID from the access token (the requester, "sub")
+    # make sure user {user_id} exists in CRM and identity service
+    # make sure reporting org exists
+    # make sure "sub" has the permissions to set user authz for this reporting org
+    # make sure user {user_id} and reporting org are related in CRM
+    # make sure user {user_id} has an FGA token in the identity service
+    # update token in the identity service
     raise fastapi.HTTPException(
         status_code=fastapi.status.HTTP_501_NOT_IMPLEMENTED,
         detail="Not yet implemented",
@@ -41,6 +57,16 @@ def remove_user_from_reporting_org(
         authn.parse_decoded_token, scopes=["ryd", "ryd:reporting_org:user:update"]
     ),
 ) -> JSONResponse:
+    # check token has required scopes
+    # check roles
+    # get user ID from the access token (the requester, "sub")
+    # make sure user {user_id} exists in CRM and identity service
+    # make sure reporting org exists
+    # make sure "sub" has the permissions to set user authz for this reporting org
+    # make sure user {user_id} and reporting org are related in CRM
+    # make sure user {user_id} has an FGA token in the identity service
+    # update token in the identity service
+    # remove relationship between user and reporting org in the CRM
     raise fastapi.HTTPException(
         status_code=fastapi.status.HTTP_501_NOT_IMPLEMENTED,
         detail="Not yet implemented",