How one can use custom user model with Session Auth app? #165

Activity

1. dantownsend commented on Jul 24, 2022

   

   dantownsend

   on Jul 24, 2022

   Member

   More actions

   Thanks for the kind words.

   I think you need to override the login method.

   For example:

   from piccolo.apps.user.tables import BaseUser
   
   class User(BaseUser, tablename='piccolo_user'):
       @classmethod
       async def login(cls, username: str, password: str) -> t.Optional[int]:
           # authenticate the user via the blockchain
           if check_my_blockchain_service(username, password):
               user = await cls.objects().get(cls.username == username)
               if not user:
                   user = cls.create_user(
                       username=username,
                       password=password,
                       active=True,
                       admin=True, # only if you want to give them access to Piccolo admin
                       superuser=True # only if you want to have super user privileges in Piccolo admin
                   )
               return user.id
           else:
               return None
   
   # Pass this BaseUser subclass into any session auth middleware or endpoints, for example:
   from piccolo_api.session_auth.endpoints import session_login
   from fastapi import FastAPI
   
   app = FastAPI()
   
   app.mount('/login/', session_login(auth_table=User))
2. Akkarine commented on Jul 25, 2022

   

   Akkarine

   on Jul 25, 2022

   Last edited by Akkarine

   Author

   More actions

   Thank you for answer.

   But what if I don't need a password field at all? Like I will have only OpenID authorization? How can I remove some fields?
   I mean, what if BaseUser would be just empty class (or just with id Field, needed for sessions), that I can inherit and completely rewrite it in main app (including id field, want it to be uuid), so sessions could accept also custom User model?
3. sinisaos commented on Jul 25, 2022

   

   sinisaos

   on Jul 25, 2022

   Member

   More actions

   @Akkarine The main problem is that BaseUser requires fields username and password (create_user() method) and session auth depends on BaseUser. You can try this.This basically saves the Google user as a Piccolo BaseUser, and later you can use it as a normal BaseUser with session auth.
   Here is another example (Vue frontend, but it doesn't matter) where I used fake password for register Google user as BaseUser to satisfy Pydantic validation on backend and creation of Piccolo BaseUser which requires password field. After that you can use session auth.
   I hope you find something usefull in this examples.
4. Akkarine commented on Jul 25, 2022

   

   Akkarine

   on Jul 25, 2022

   Author

   More actions

   Thank you, @sinisaos , I had similar ideas, but thought, maybe this (customizable User class) could be point of improvement for piccolo.

   👍React with 👍1Reacted by sinisaos
5. northpowered commented on Aug 9, 2022

   

   northpowered

   on Aug 9, 2022

   More actions

   @Akkarine if u are interested in combining session auth + custom user model, u can try smth like this:
   Session Model and logic
   User model and login method
   Using this in Piccolo Admin GUI

   👍React with 👍1Reacted by Dmitry
6. sinisaos

   converted this issue into a discussion #315 on Aug 7, 2025