Module supertokens_python.recipe.thirdpartyemailpassword.interfaces

Classes

class APIInterface

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code

class APIInterface(ABC):
    def __init__(self):
        self.disable_thirdparty_sign_in_up_post = False
        self.disable_emailpassword_sign_up_post = False
        self.disable_emailpassword_sign_in_post = False
        self.disable_authorisation_url_get = False
        self.disable_email_exists_get = False
        self.disable_generate_password_reset_token_post = False
        self.disable_password_reset_post = False
        self.disable_apple_redirect_handler_post = False

    @abstractmethod
    async def authorisation_url_get(self, provider: Provider,
                                    api_options: ThirdPartyApiOptions) -> AuthorisationUrlGetResponse:
        pass

    @abstractmethod
    async def thirdparty_sign_in_up_post(self, provider: Provider, code: str, redirect_uri: str, client_id: Union[str, None],
                                         auth_code_response: Union[str, None], api_options: ThirdPartyApiOptions) -> SignInUpPostResponse:
        pass

    @abstractmethod
    async def emailpassword_sign_in_post(self, form_fields: List[FormField],
                                         api_options: EmailPasswordApiOptions) -> SignInPostResponse:
        pass

    @abstractmethod
    async def emailpassword_sign_up_post(self, form_fields: List[FormField],
                                         api_options: EmailPasswordApiOptions) -> SignUpPostResponse:
        pass

    @abstractmethod
    async def email_exists_get(self, email: str, api_options: EmailPasswordApiOptions) -> EmailExistsGetResponse:
        pass

    @abstractmethod
    async def generate_password_reset_token_post(self, form_fields: List[FormField],
                                                 api_options: EmailPasswordApiOptions) -> GeneratePasswordResetTokenPostResponse:
        pass

    @abstractmethod
    async def password_reset_post(self, token: str, form_fields: List[FormField],
                                  api_options: EmailPasswordApiOptions) -> PasswordResetPostResponse:
        pass

    @abstractmethod
    async def apple_redirect_handler_post(self, code: str, state: str, api_options: ThirdPartyApiOptions):
        pass

Ancestors

• abc.ABC

Subclasses

• APIImplementation

Methods

async def apple_redirect_handler_post(self, code: str, state: str, api_options: APIOptions)

Expand source code

@abstractmethod
async def apple_redirect_handler_post(self, code: str, state: str, api_options: ThirdPartyApiOptions):
    pass

async def authorisation_url_get(self, provider: Provider, api_options: APIOptions) ‑> AuthorisationUrlGetResponse

Expand source code

@abstractmethod
async def authorisation_url_get(self, provider: Provider,
                                api_options: ThirdPartyApiOptions) -> AuthorisationUrlGetResponse:
    pass

async def email_exists_get(self, email: str, api_options: APIOptions) ‑> EmailExistsGetResponse

Expand source code

@abstractmethod
async def email_exists_get(self, email: str, api_options: EmailPasswordApiOptions) -> EmailExistsGetResponse:
    pass

async def emailpassword_sign_in_post(self, form_fields: List[FormField], api_options: APIOptions) ‑> SignInPostResponse

Expand source code

@abstractmethod
async def emailpassword_sign_in_post(self, form_fields: List[FormField],
                                     api_options: EmailPasswordApiOptions) -> SignInPostResponse:
    pass

async def emailpassword_sign_up_post(self, form_fields: List[FormField], api_options: APIOptions) ‑> SignUpPostResponse

Expand source code

@abstractmethod
async def emailpassword_sign_up_post(self, form_fields: List[FormField],
                                     api_options: EmailPasswordApiOptions) -> SignUpPostResponse:
    pass

async def generate_password_reset_token_post(self, form_fields: List[FormField], api_options: APIOptions) ‑> GeneratePasswordResetTokenPostResponse

Expand source code

@abstractmethod
async def generate_password_reset_token_post(self, form_fields: List[FormField],
                                             api_options: EmailPasswordApiOptions) -> GeneratePasswordResetTokenPostResponse:
    pass

async def password_reset_post(self, token: str, form_fields: List[FormField], api_options: APIOptions) ‑> PasswordResetPostResponse

Expand source code

@abstractmethod
async def password_reset_post(self, token: str, form_fields: List[FormField],
                              api_options: EmailPasswordApiOptions) -> PasswordResetPostResponse:
    pass

async def thirdparty_sign_in_up_post(self, provider: Provider, code: str, redirect_uri: str, client_id: Optional[str], auth_code_response: Optional[str], api_options: APIOptions) ‑> SignInUpPostResponse

Expand source code

@abstractmethod
async def thirdparty_sign_in_up_post(self, provider: Provider, code: str, redirect_uri: str, client_id: Union[str, None],
                                     auth_code_response: Union[str, None], api_options: ThirdPartyApiOptions) -> SignInUpPostResponse:
    pass

class RecipeInterface

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code

class RecipeInterface(ABC):
    def __init__(self):
        pass

    @abstractmethod
    async def get_user_by_id(self, user_id: str) -> Union[User, None]:
        pass

    @abstractmethod
    async def get_users_by_email(self, email: str) -> List[User]:
        pass

    @abstractmethod
    async def get_user_by_thirdparty_info(self, third_party_id: str, third_party_user_id: str) -> Union[User, None]:
        pass

    @abstractmethod
    async def sign_in_up(self, third_party_id: str, third_party_user_id: str, email: str,
                         email_verified: bool) -> SignInUpResult:
        pass

    @abstractmethod
    async def sign_in(self, email: str, password: str) -> SignInResult:
        pass

    @abstractmethod
    async def sign_up(self, email: str, password: str) -> SignUpResult:
        pass

    @abstractmethod
    async def get_users_oldest_first(self, limit: int = None, next_pagination: str = None) -> UsersResponse:
        pass

    @abstractmethod
    async def get_users_newest_first(self, limit: int = None, next_pagination: str = None) -> UsersResponse:
        pass

    @abstractmethod
    async def get_user_count(self) -> int:
        pass

    @abstractmethod
    async def create_reset_password_token(self, user_id: str) -> CreateResetPasswordResult:
        pass

    @abstractmethod
    async def reset_password_using_token(self, token: str, new_password: str) -> ResetPasswordUsingTokenResult:
        pass

    @abstractmethod
    async def update_email_or_password(self, user_id: str, email: str = None,
                                       password: str = None) -> UpdateEmailOrPasswordResult:
        pass

Ancestors

• abc.ABC

Subclasses

• RecipeImplementation

Methods

async def create_reset_password_token(self, user_id: str) ‑> CreateResetPasswordResult

Expand source code

@abstractmethod
async def create_reset_password_token(self, user_id: str) -> CreateResetPasswordResult:
    pass

async def get_user_by_id(self, user_id: str) ‑> Optional[User]

Expand source code

@abstractmethod
async def get_user_by_id(self, user_id: str) -> Union[User, None]:
    pass

async def get_user_by_thirdparty_info(self, third_party_id: str, third_party_user_id: str) ‑> Optional[User]

Expand source code

@abstractmethod
async def get_user_by_thirdparty_info(self, third_party_id: str, third_party_user_id: str) -> Union[User, None]:
    pass

async def get_user_count(self) ‑> int

Expand source code

@abstractmethod
async def get_user_count(self) -> int:
    pass

async def get_users_by_email(self, email: str) ‑> List[User]

Expand source code

@abstractmethod
async def get_users_by_email(self, email: str) -> List[User]:
    pass

async def get_users_newest_first(self, limit: int = None, next_pagination: str = None) ‑> UsersResponse

Expand source code

@abstractmethod
async def get_users_newest_first(self, limit: int = None, next_pagination: str = None) -> UsersResponse:
    pass

async def get_users_oldest_first(self, limit: int = None, next_pagination: str = None) ‑> UsersResponse

Expand source code

@abstractmethod
async def get_users_oldest_first(self, limit: int = None, next_pagination: str = None) -> UsersResponse:
    pass

async def reset_password_using_token(self, token: str, new_password: str) ‑> ResetPasswordUsingTokenResult

Expand source code

@abstractmethod
async def reset_password_using_token(self, token: str, new_password: str) -> ResetPasswordUsingTokenResult:
    pass

async def sign_in(self, email: str, password: str) ‑> SignInResult

Expand source code

@abstractmethod
async def sign_in(self, email: str, password: str) -> SignInResult:
    pass

async def sign_in_up(self, third_party_id: str, third_party_user_id: str, email: str, email_verified: bool) ‑> SignInUpResult

Expand source code

@abstractmethod
async def sign_in_up(self, third_party_id: str, third_party_user_id: str, email: str,
                     email_verified: bool) -> SignInUpResult:
    pass

async def sign_up(self, email: str, password: str) ‑> SignUpResult

Expand source code

@abstractmethod
async def sign_up(self, email: str, password: str) -> SignUpResult:
    pass

async def update_email_or_password(self, user_id: str, email: str = None, password: str = None) ‑> UpdateEmailOrPasswordResult

Expand source code

@abstractmethod
async def update_email_or_password(self, user_id: str, email: str = None,
                                   password: str = None) -> UpdateEmailOrPasswordResult:
    pass