Module supertokens_python.recipe.webauthn.interfaces.recipe

Classes

class AuthenticationPayload (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class AuthenticationPayload(CredentialPayloadBase):
    response: AuthenticatorAssertionResponseJSON

Ancestors

• CredentialPayloadBase
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel

Class variables

var response : AuthenticatorAssertionResponseJSON

The type of the None singleton.

Inherited members

• CredentialPayloadBase:
  • authenticatorAttachment
  • clientExtensionResults
  • from_json
  • id
  • model_config
  • rawId
  • to_json
  • type

class AuthenticatorAssertionResponseJSON (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class AuthenticatorAssertionResponseJSON(CamelCaseBaseModel):
    clientDataJSON: Base64URLString
    authenticatorData: Base64URLString
    signature: Base64URLString
    userHandle: Optional[Base64URLString] = None

Ancestors

• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel

Class variables

var authenticatorData : str

The type of the None singleton.

var clientDataJSON : str

The type of the None singleton.

var signature : str

The type of the None singleton.

var userHandle : Optional[str]

The type of the None singleton.

Inherited members

• CamelCaseBaseModel:
  • from_json
  • model_config
  • to_json

class AuthenticatorAttestationResponseJSON (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class AuthenticatorAttestationResponseJSON(CamelCaseBaseModel):
    clientDataJSON: Base64URLString
    attestationObject: Base64URLString
    authenticatorData: Optional[Base64URLString] = None
    transports: Optional[
        List[
            Literal[
                "ble",
                "cable",
                "hybrid",
                "internal",
                "nfc",
                "smart-card",
                "usb",
            ]
        ]
    ] = None
    publicKeyAlgorithm: Optional[COSEAlgorithmIdentifier] = None
    publicKey: Optional[Base64URLString] = None

Ancestors

• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel

Class variables

var attestationObject : str

The type of the None singleton.

var authenticatorData : Optional[str]

The type of the None singleton.

var clientDataJSON : str

The type of the None singleton.

var publicKey : Optional[str]

The type of the None singleton.

var publicKeyAlgorithm : Optional[int]

The type of the None singleton.

var transports : Optional[List[Literal['ble', 'cable', 'hybrid', 'internal', 'nfc', 'smart-card', 'usb']]]

The type of the None singleton.

Inherited members

• CamelCaseBaseModel:
  • from_json
  • model_config
  • to_json

class ConsumeRecoverAccountTokenResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class ConsumeRecoverAccountTokenResponse(OkResponseBaseModel):
    email: str
    user_id: str

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var email : str

The type of the None singleton.

var user_id : str

The type of the None singleton.

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class CreateNewRecipeUserResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class CreateNewRecipeUserResponse(OkResponseBaseModel):
    user: User
    recipe_user_id: RecipeUserId

    @field_serializer("user")
    def serialize_user(self, user: User):
        return user.to_json()

    @field_serializer("recipe_user_id")
    def serialize_recipe_user_id(self, rui: RecipeUserId):
        return rui.get_as_string()

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var recipe_user_id : RecipeUserId

The type of the None singleton.

var user : User

The type of the None singleton.

Methods

def serialize_recipe_user_id(self, rui: RecipeUserId)

def serialize_user(self, user: User)

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class CreateRecoverAccountLinkResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class CreateRecoverAccountLinkResponse(OkResponseBaseModel):
    link: str

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var link : str

The type of the None singleton.

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class CredentialNotFoundErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class CredentialNotFoundErrorResponse(
    StatusResponseBaseModel[Literal["CREDENTIAL_NOT_FOUND_ERROR"]]
):
    status: Literal["CREDENTIAL_NOT_FOUND_ERROR"] = "CREDENTIAL_NOT_FOUND_ERROR"

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['CREDENTIAL_NOT_FOUND_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var model_config

The type of the None singleton.

var status : Literal['CREDENTIAL_NOT_FOUND_ERROR']

The type of the None singleton.

class RemoveCredentialErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class CredentialNotFoundErrorResponse(
    StatusResponseBaseModel[Literal["CREDENTIAL_NOT_FOUND_ERROR"]]
):
    status: Literal["CREDENTIAL_NOT_FOUND_ERROR"] = "CREDENTIAL_NOT_FOUND_ERROR"

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['CREDENTIAL_NOT_FOUND_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var model_config

The type of the None singleton.

var status : Literal['CREDENTIAL_NOT_FOUND_ERROR']

The type of the None singleton.

class GetCredentialErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class CredentialNotFoundErrorResponse(
    StatusResponseBaseModel[Literal["CREDENTIAL_NOT_FOUND_ERROR"]]
):
    status: Literal["CREDENTIAL_NOT_FOUND_ERROR"] = "CREDENTIAL_NOT_FOUND_ERROR"

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['CREDENTIAL_NOT_FOUND_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Inherited members

• StatusResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class CredentialPayload (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class CredentialPayload(CredentialPayloadBase):
    class Response(CamelCaseBaseModel):
        client_data_json: str
        attestation_object: str
        transports: Optional[
            List[
                Literal[
                    "ble",
                    "cable",
                    "hybrid",
                    "internal",
                    "nfc",
                    "smart-card",
                    "usb",
                ]
            ]
        ] = None
        user_handle: str

    response: Response

Ancestors

• CredentialPayloadBase
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel

Class variables

var Response

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

var response : CredentialPayload.Response

The type of the None singleton.

Inherited members

• CredentialPayloadBase:
  • authenticatorAttachment
  • clientExtensionResults
  • from_json
  • id
  • model_config
  • rawId
  • to_json
  • type

class CredentialPayloadBase (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class CredentialPayloadBase(CamelCaseBaseModel):
    id: str
    rawId: str
    authenticatorAttachment: Optional[
        Literal[
            "platform",
            "cross-platform",
        ]
    ] = None
    # Default value required since inputs come from users, might omit this
    # Not provided in the webauthn authenticator used in backend-sdk-testing
    clientExtensionResults: Dict[str, Any] = Field(default_factory=dict)
    type: Literal["public-key"]

Ancestors

• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel

Subclasses

• AuthenticationPayload
• CredentialPayload
• RegistrationPayload

Class variables

var authenticatorAttachment : Optional[Literal['platform', 'cross-platform']]

The type of the None singleton.

var clientExtensionResults : Dict[str, Any]

The type of the None singleton.

var id : str

The type of the None singleton.

var rawId : str

The type of the None singleton.

var type : Literal['public-key']

The type of the None singleton.

Inherited members

• CamelCaseBaseModel:
  • from_json
  • model_config
  • to_json

class DisplayNameEmailInput (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Expand source code

class DisplayNameEmailInput(TypedDict):
    display_name: Optional[str]
    email: str

Ancestors

• builtins.dict

Class variables

var display_name : Optional[str]

The type of the None singleton.

var email : str

The type of the None singleton.

class EmailAlreadyExistsErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class EmailAlreadyExistsErrorResponse(
    StatusResponseBaseModel[Literal["EMAIL_ALREADY_EXISTS_ERROR"]]
):
    status: Literal["EMAIL_ALREADY_EXISTS_ERROR"] = "EMAIL_ALREADY_EXISTS_ERROR"

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['EMAIL_ALREADY_EXISTS_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Inherited members

• StatusResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class GenerateRecoverAccountTokenResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class GenerateRecoverAccountTokenResponse(OkResponseBaseModel):
    token: str

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var token : str

The type of the None singleton.

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class GetCredentialResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class GetCredentialResponse(OkResponseBaseModel):
    webauthn_credential_id: str
    relying_party_id: str
    recipe_user_id: RecipeUserId
    created_at: int

    @field_serializer("recipe_user_id")
    def serialize_recipe_user_id(self, rui: RecipeUserId):
        return rui.get_as_string()

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var created_at : int

The type of the None singleton.

var recipe_user_id : RecipeUserId

The type of the None singleton.

var relying_party_id : str

The type of the None singleton.

var webauthn_credential_id : str

The type of the None singleton.

Methods

def serialize_recipe_user_id(self, rui: RecipeUserId)

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class GetGeneratedOptionsResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class GetGeneratedOptionsResponse(OkResponseBaseModel):
    webauthn_generated_options_id: str
    relying_party_id: str
    relying_party_name: str
    user_verification: UserVerification
    user_presence: bool
    origin: str
    email: Optional[str]
    timeout: int
    challenge: str
    created_at: int
    expires_at: int

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var challenge : str

The type of the None singleton.

var created_at : int

The type of the None singleton.

var email : Optional[str]

The type of the None singleton.

var expires_at : int

The type of the None singleton.

var origin : str

The type of the None singleton.

var relying_party_id : str

The type of the None singleton.

var relying_party_name : str

The type of the None singleton.

var timeout : int

The type of the None singleton.

var user_presence : bool

The type of the None singleton.

var user_verification : Literal['required', 'preferred', 'discouraged']

The type of the None singleton.

var webauthn_generated_options_id : str

The type of the None singleton.

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class GetUserFromRecoverAccountTokenResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class GetUserFromRecoverAccountTokenResponse(OkResponseBaseModel):
    user: User
    recipe_user_id: Optional[RecipeUserId]

    @field_serializer("user")
    def serialize_user(self, user: User):
        return user.to_json()

    @field_serializer("recipe_user_id")
    def serialize_recipe_user_id(self, rui: Optional[RecipeUserId]):
        if rui is None:
            return None

        return rui.get_as_string()

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var recipe_user_id : Optional[RecipeUserId]

The type of the None singleton.

var user : User

The type of the None singleton.

Methods

def serialize_recipe_user_id(self, rui: Optional[RecipeUserId])

def serialize_user(self, user: User)

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class InvalidAuthenticatorErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class InvalidAuthenticatorErrorResponse(
    StatusReasonResponseBaseModel[Literal["INVALID_AUTHENTICATOR_ERROR"], str]
):
    status: Literal["INVALID_AUTHENTICATOR_ERROR"] = "INVALID_AUTHENTICATOR_ERROR"

Ancestors

• supertokens_python.types.response.StatusReasonResponseBaseModel[Literal['INVALID_AUTHENTICATOR_ERROR'], str]
• StatusReasonResponseBaseModel
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Inherited members

• StatusReasonResponseBaseModel:
  • from_json
  • model_config
  • reason
  • status
  • to_json

class InvalidCredentialsErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class InvalidCredentialsErrorResponse(
    StatusResponseBaseModel[Literal["INVALID_CREDENTIALS_ERROR"]]
):
    status: Literal["INVALID_CREDENTIALS_ERROR"] = "INVALID_CREDENTIALS_ERROR"

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['INVALID_CREDENTIALS_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Inherited members

• StatusResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class InvalidEmailErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class InvalidEmailErrorResponse(
    StatusErrResponseBaseModel[Literal["INVALID_EMAIL_ERROR"]]
):
    status: Literal["INVALID_EMAIL_ERROR"] = "INVALID_EMAIL_ERROR"

Ancestors

• supertokens_python.types.response.StatusErrResponseBaseModel[Literal['INVALID_EMAIL_ERROR']]
• StatusErrResponseBaseModel
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Inherited members

• StatusErrResponseBaseModel:
  • err
  • from_json
  • model_config
  • status
  • to_json

class InvalidOptionsErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class InvalidOptionsErrorResponse(
    StatusResponseBaseModel[Literal["INVALID_OPTIONS_ERROR"]]
):
    status: Literal["INVALID_OPTIONS_ERROR"] = "INVALID_OPTIONS_ERROR"

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['INVALID_OPTIONS_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var model_config

The type of the None singleton.

var status : Literal['INVALID_OPTIONS_ERROR']

The type of the None singleton.

class SignInOptionsErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class InvalidOptionsErrorResponse(
    StatusResponseBaseModel[Literal["INVALID_OPTIONS_ERROR"]]
):
    status: Literal["INVALID_OPTIONS_ERROR"] = "INVALID_OPTIONS_ERROR"

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['INVALID_OPTIONS_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Inherited members

• StatusResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class ListCredentialsResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class ListCredentialsResponse(OkResponseBaseModel):
    class Credential(CamelCaseBaseModel):
        webauthn_credential_id: str
        relying_party_id: str
        recipe_user_id: str
        created_at: int

    credentials: List[Credential]

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var Credential

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

var credentials : List[ListCredentialsResponse.Credential]

The type of the None singleton.

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class OptionsNotFoundErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class OptionsNotFoundErrorResponse(
    StatusResponseBaseModel[Literal["OPTIONS_NOT_FOUND_ERROR"]]
):
    status: Literal["OPTIONS_NOT_FOUND_ERROR"] = "OPTIONS_NOT_FOUND_ERROR"

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['OPTIONS_NOT_FOUND_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var model_config

The type of the None singleton.

var status : Literal['OPTIONS_NOT_FOUND_ERROR']

The type of the None singleton.

class RemoveGeneratedOptionsErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class OptionsNotFoundErrorResponse(
    StatusResponseBaseModel[Literal["OPTIONS_NOT_FOUND_ERROR"]]
):
    status: Literal["OPTIONS_NOT_FOUND_ERROR"] = "OPTIONS_NOT_FOUND_ERROR"

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['OPTIONS_NOT_FOUND_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var model_config

The type of the None singleton.

var status : Literal['OPTIONS_NOT_FOUND_ERROR']

The type of the None singleton.

class GetGeneratedOptionsErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class OptionsNotFoundErrorResponse(
    StatusResponseBaseModel[Literal["OPTIONS_NOT_FOUND_ERROR"]]
):
    status: Literal["OPTIONS_NOT_FOUND_ERROR"] = "OPTIONS_NOT_FOUND_ERROR"

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['OPTIONS_NOT_FOUND_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Inherited members

• StatusResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class RecipeInterface

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

Expand source code

class RecipeInterface(BaseRecipeInterface):
    @abstractmethod
    async def register_options(
        self,
        *,
        relying_party_id: str,
        relying_party_name: str,
        origin: str,
        resident_key: Optional[ResidentKey] = None,
        user_verification: Optional[UserVerification] = None,
        user_presence: Optional[bool] = None,
        attestation: Optional[Attestation] = None,
        supported_algorithm_ids: Optional[List[int]] = None,
        timeout: Optional[int] = None,
        tenant_id: str,
        user_context: UserContext,
        **kwargs: Unpack[RegisterOptionsKwargsInput],
    ) -> Union[RegisterOptionsResponse, RegisterOptionsErrorResponse]: ...

    @abstractmethod
    async def sign_in_options(
        self,
        *,
        relying_party_id: str,
        relying_party_name: str,
        origin: str,
        user_verification: Optional[UserVerification] = None,
        user_presence: Optional[bool] = None,
        timeout: Optional[int] = None,
        tenant_id: str,
        user_context: UserContext,
    ) -> Union[SignInOptionsResponse, SignInOptionsErrorResponse]: ...

    @abstractmethod
    async def sign_up(
        self,
        *,
        webauthn_generated_options_id: str,
        credential: RegistrationPayload,
        session: Optional[SessionContainer] = None,
        should_try_linking_with_session_user: Optional[bool] = None,
        tenant_id: str,
        user_context: UserContext,
    ) -> Union[SignUpReponse, SignUpErrorResponse]: ...

    @abstractmethod
    async def sign_in(
        self,
        *,
        webauthn_generated_options_id: str,
        credential: AuthenticationPayload,
        session: Optional[SessionContainer] = None,
        should_try_linking_with_session_user: Optional[bool] = None,
        tenant_id: str,
        user_context: UserContext,
    ) -> Union[SignInResponse, SignInErrorResponse]: ...

    @abstractmethod
    async def verify_credentials(
        self,
        *,
        webauthn_generated_options_id: str,
        credential: AuthenticationPayload,
        tenant_id: str,
        user_context: UserContext,
    ) -> Union[VerifyCredentialsResponse, VerifyCredentialsErrorResponse]: ...

    @abstractmethod
    async def create_new_recipe_user(
        self,
        *,
        webauthn_generated_options_id: str,
        credential: RegistrationPayload,
        tenant_id: str,
        user_context: UserContext,
    ) -> Union[CreateNewRecipeUserResponse, CreateNewRecipeUserErrorResponse]:
        """
        This function is meant only for creating the recipe in the core and nothing else.
        We added this even though signUp exists cause devs may override signup expecting it
        to be called just during sign up. But we also need a version of signing up which can be
        called during operations like creating a user during account recovery flow.
        """
        ...

    @abstractmethod
    async def generate_recover_account_token(
        self,
        *,
        user_id: str,
        email: str,
        tenant_id: str,
        user_context: UserContext,
    ) -> Union[
        GenerateRecoverAccountTokenResponse,
        GenerateRecoverAccountTokenErrorResponse,
    ]:
        """
        We pass in the email as well to this function cause the input userId
        may not be associated with an webauthn account. In this case, we
        need to know which email to use to create an webauthn account later on.
        """

    @abstractmethod
    async def consume_recover_account_token(
        self,
        *,
        token: str,
        tenant_id: str,
        user_context: UserContext,
    ) -> Union[
        ConsumeRecoverAccountTokenResponse, ConsumeRecoverAccountTokenErrorResponse
    ]: ...

    @abstractmethod
    async def register_credential(
        self,
        *,
        webauthn_generated_options_id: str,
        credential: RegistrationPayload,
        user_context: UserContext,
        recipe_user_id: str,
    ) -> Union[OkResponseBaseModel, RegisterCredentialErrorResponse]: ...

    @abstractmethod
    async def get_user_from_recover_account_token(
        self,
        *,
        token: str,
        tenant_id: str,
        user_context: UserContext,
    ) -> Union[
        GetUserFromRecoverAccountTokenResponse,
        GetUserFromRecoverAccountTokenErrorResponse,
    ]: ...

    @abstractmethod
    async def remove_credential(
        self,
        *,
        webauthn_credential_id: str,
        recipe_user_id: str,
        user_context: UserContext,
    ) -> Union[OkResponseBaseModel, RemoveCredentialErrorResponse]: ...

    @abstractmethod
    async def get_credential(
        self,
        *,
        webauthn_credential_id: str,
        recipe_user_id: str,
        user_context: UserContext,
    ) -> Union[GetCredentialResponse, GetCredentialErrorResponse]: ...

    @abstractmethod
    async def list_credentials(
        self,
        *,
        recipe_user_id: str,
        user_context: UserContext,
    ) -> ListCredentialsResponse: ...

    @abstractmethod
    async def remove_generated_options(
        self,
        *,
        webauthn_generated_options_id: str,
        tenant_id: str,
        user_context: UserContext,
    ) -> Union[OkResponseBaseModel, RemoveGeneratedOptionsErrorResponse]: ...

    @abstractmethod
    async def get_generated_options(
        self,
        *,
        webauthn_generated_options_id: str,
        tenant_id: str,
        user_context: UserContext,
    ) -> Union[GetGeneratedOptionsResponse, GetGeneratedOptionsErrorResponse]: ...

    @abstractmethod
    async def update_user_email(
        self,
        *,
        recipe_user_id: str,
        email: str,
        tenant_id: str,
        user_context: UserContext,
    ) -> Union[OkResponseBaseModel, UpdateUserEmailErrorResponse]: ...

Ancestors

• BaseRecipeInterface
• abc.ABC

Subclasses

• RecipeImplementation

Methods

async def consume_recover_account_token(self, *, token: str, tenant_id: str, user_context: Dict[str, Any]) ‑> Union[ConsumeRecoverAccountTokenResponse, RecoverAccountTokenInvalidErrorResponse]

async def create_new_recipe_user(self, *, webauthn_generated_options_id: str, credential: RegistrationPayload, tenant_id: str, user_context: Dict[str, Any]) ‑> Union[CreateNewRecipeUserResponse, EmailAlreadyExistsErrorResponse, OptionsNotFoundErrorResponse, InvalidOptionsErrorResponse, InvalidCredentialsErrorResponse, InvalidAuthenticatorErrorResponse]

This function is meant only for creating the recipe in the core and nothing else. We added this even though signUp exists cause devs may override signup expecting it to be called just during sign up. But we also need a version of signing up which can be called during operations like creating a user during account recovery flow.

async def generate_recover_account_token(self, *, user_id: str, email: str, tenant_id: str, user_context: Dict[str, Any]) ‑> Union[GenerateRecoverAccountTokenResponse, UnknownUserIdErrorResponse]

We pass in the email as well to this function cause the input userId may not be associated with an webauthn account. In this case, we need to know which email to use to create an webauthn account later on.

async def get_credential(self, *, webauthn_credential_id: str, recipe_user_id: str, user_context: Dict[str, Any]) ‑> Union[GetCredentialResponse, CredentialNotFoundErrorResponse]

async def get_generated_options(self, *, webauthn_generated_options_id: str, tenant_id: str, user_context: Dict[str, Any]) ‑> Union[GetGeneratedOptionsResponse, OptionsNotFoundErrorResponse]

async def get_user_from_recover_account_token(self, *, token: str, tenant_id: str, user_context: Dict[str, Any]) ‑> Union[GetUserFromRecoverAccountTokenResponse, RecoverAccountTokenInvalidErrorResponse]

async def list_credentials(self, *, recipe_user_id: str, user_context: Dict[str, Any]) ‑> ListCredentialsResponse

async def register_credential(self, *, webauthn_generated_options_id: str, credential: RegistrationPayload, user_context: Dict[str, Any], recipe_user_id: str) ‑> Union[OkResponseBaseModel, InvalidCredentialsErrorResponse, OptionsNotFoundErrorResponse, InvalidOptionsErrorResponse, InvalidAuthenticatorErrorResponse]

async def register_options(self, *, relying_party_id: str, relying_party_name: str, origin: str, resident_key: Optional[Literal['required', 'preferred', 'discouraged']] = None, user_verification: Optional[Literal['required', 'preferred', 'discouraged']] = None, user_presence: Optional[bool] = None, attestation: Optional[Literal['none', 'indirect', 'direct', 'enterprise']] = None, supported_algorithm_ids: Optional[List[int]] = None, timeout: Optional[int] = None, tenant_id: str, user_context: Dict[str, Any], **kwargs: Unpack[RegisterOptionsKwargsInput]) ‑> Union[RegisterOptionsResponse, RecoverAccountTokenInvalidErrorResponse, InvalidOptionsErrorResponse, InvalidEmailErrorResponse]

async def remove_credential(self, *, webauthn_credential_id: str, recipe_user_id: str, user_context: Dict[str, Any]) ‑> Union[OkResponseBaseModel, CredentialNotFoundErrorResponse]

async def remove_generated_options(self, *, webauthn_generated_options_id: str, tenant_id: str, user_context: Dict[str, Any]) ‑> Union[OkResponseBaseModel, OptionsNotFoundErrorResponse]

async def sign_in(self, *, webauthn_generated_options_id: str, credential: AuthenticationPayload, session: Optional[SessionContainer] = None, should_try_linking_with_session_user: Optional[bool] = None, tenant_id: str, user_context: Dict[str, Any]) ‑> Union[SignInResponse, InvalidCredentialsErrorResponse, InvalidOptionsErrorResponse, InvalidAuthenticatorErrorResponse, CredentialNotFoundErrorResponse, UnknownUserIdErrorResponse, OptionsNotFoundErrorResponse, LinkingToSessionUserFailedError]

async def sign_in_options(self, *, relying_party_id: str, relying_party_name: str, origin: str, user_verification: Optional[Literal['required', 'preferred', 'discouraged']] = None, user_presence: Optional[bool] = None, timeout: Optional[int] = None, tenant_id: str, user_context: Dict[str, Any]) ‑> Union[SignInOptionsResponse, InvalidOptionsErrorResponse]

async def sign_up(self, *, webauthn_generated_options_id: str, credential: RegistrationPayload, session: Optional[SessionContainer] = None, should_try_linking_with_session_user: Optional[bool] = None, tenant_id: str, user_context: Dict[str, Any]) ‑> Union[SignUpReponse, EmailAlreadyExistsErrorResponse, OptionsNotFoundErrorResponse, InvalidOptionsErrorResponse, InvalidCredentialsErrorResponse, InvalidAuthenticatorErrorResponse, LinkingToSessionUserFailedError]

async def update_user_email(self, *, recipe_user_id: str, email: str, tenant_id: str, user_context: Dict[str, Any]) ‑> Union[OkResponseBaseModel, EmailAlreadyExistsErrorResponse, UnknownUserIdErrorResponse]

async def verify_credentials(self, *, webauthn_generated_options_id: str, credential: AuthenticationPayload, tenant_id: str, user_context: Dict[str, Any]) ‑> Union[VerifyCredentialsResponse, InvalidCredentialsErrorResponse, InvalidOptionsErrorResponse, InvalidAuthenticatorErrorResponse, CredentialNotFoundErrorResponse, UnknownUserIdErrorResponse, OptionsNotFoundErrorResponse]

class RecoverAccountTokenInput (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Expand source code

class RecoverAccountTokenInput(TypedDict):
    recover_account_token: str

Ancestors

• builtins.dict

Class variables

var recover_account_token : str

The type of the None singleton.

class RecoverAccountTokenInvalidErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class RecoverAccountTokenInvalidErrorResponse(
    StatusResponseBaseModel[Literal["RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"]]
):
    status: Literal["RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"] = (
        "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"
    )

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['RECOVER_ACCOUNT_TOKEN_INVALID_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var model_config

The type of the None singleton.

var status : Literal['RECOVER_ACCOUNT_TOKEN_INVALID_ERROR']

The type of the None singleton.

class ConsumeRecoverAccountTokenErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class RecoverAccountTokenInvalidErrorResponse(
    StatusResponseBaseModel[Literal["RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"]]
):
    status: Literal["RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"] = (
        "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"
    )

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['RECOVER_ACCOUNT_TOKEN_INVALID_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var model_config

The type of the None singleton.

var status : Literal['RECOVER_ACCOUNT_TOKEN_INVALID_ERROR']

The type of the None singleton.

class GetUserFromRecoverAccountTokenErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class RecoverAccountTokenInvalidErrorResponse(
    StatusResponseBaseModel[Literal["RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"]]
):
    status: Literal["RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"] = (
        "RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"
    )

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['RECOVER_ACCOUNT_TOKEN_INVALID_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Inherited members

• StatusResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class RegisterOptionsKwargsInput (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Expand source code

class RegisterOptionsKwargsInput(TypedDict):
    recover_account_token: NotRequired[str]
    display_name: NotRequired[str]
    email: NotRequired[str]

Ancestors

• builtins.dict

Class variables

var display_name : str

The type of the None singleton.

var email : str

The type of the None singleton.

var recover_account_token : str

The type of the None singleton.

class RegisterOptionsResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class RegisterOptionsResponse(OkResponseBaseModel):
    # for understanding the response, see https://www.w3.org/TR/webauthn-3/#sctn-registering-a-new-credential
    # and https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredential

    class RelyingParty(CamelCaseBaseModel):
        id: str
        name: str

    class User(CamelCaseBaseModel):
        id: str
        name: str  # user email
        display_name: str  # user email

    class ExcludeCredentials(CamelCaseBaseModel):
        id: str
        transports: List[
            Literal[
                "ble",
                "hybrid",
                "internal",
                "nfc",
                "usb",
            ]
        ]
        type: Literal["public-key"]

    class PubKeyCredParams(CamelCaseBaseModel):
        # we will default to [-8, -7, -257] as supported algorithms.
        # See https://www.iana.org/assignments/cose/cose.xhtml#algorithms
        alg: int
        type: Literal["public-key"]

    class AuthenticatorSelection(CamelCaseBaseModel):
        require_resident_key: bool
        resident_key: ResidentKey
        user_verification: UserVerification

    webauthn_generated_options_id: str
    created_at: int
    expires_at: int
    rp: RelyingParty
    user: User
    challenge: str
    timeout: int
    exclude_credentials: List[ExcludeCredentials]
    attestation: Attestation
    pub_key_cred_params: List[PubKeyCredParams]
    authenticator_selection: AuthenticatorSelection

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var AuthenticatorSelection

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

var ExcludeCredentials

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

var PubKeyCredParams

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

var RelyingParty

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

var User

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

var attestation : Literal['none', 'indirect', 'direct', 'enterprise']

The type of the None singleton.

var authenticator_selection : RegisterOptionsResponse.AuthenticatorSelection

The type of the None singleton.

var challenge : str

The type of the None singleton.

var created_at : int

The type of the None singleton.

var exclude_credentials : List[RegisterOptionsResponse.ExcludeCredentials]

The type of the None singleton.

var expires_at : int

The type of the None singleton.

var pub_key_cred_params : List[RegisterOptionsResponse.PubKeyCredParams]

The type of the None singleton.

var rp : RegisterOptionsResponse.RelyingParty

The type of the None singleton.

var timeout : int

The type of the None singleton.

var user : RegisterOptionsResponse.User

The type of the None singleton.

var webauthn_generated_options_id : str

The type of the None singleton.

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class RegistrationPayload (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class RegistrationPayload(CredentialPayloadBase):
    response: AuthenticatorAttestationResponseJSON

Ancestors

• CredentialPayloadBase
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel

Class variables

var response : AuthenticatorAttestationResponseJSON

The type of the None singleton.

Inherited members

• CredentialPayloadBase:
  • authenticatorAttachment
  • clientExtensionResults
  • from_json
  • id
  • model_config
  • rawId
  • to_json
  • type

class SignInOptionsResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class SignInOptionsResponse(OkResponseBaseModel):
    webauthn_generated_options_id: str
    created_at: int
    expires_at: int
    rp_id: str
    challenge: str
    timeout: int
    user_verification: UserVerification

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var challenge : str

The type of the None singleton.

var created_at : int

The type of the None singleton.

var expires_at : int

The type of the None singleton.

var rp_id : str

The type of the None singleton.

var timeout : int

The type of the None singleton.

var user_verification : Literal['required', 'preferred', 'discouraged']

The type of the None singleton.

var webauthn_generated_options_id : str

The type of the None singleton.

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class SignInResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class SignInResponse(OkResponseBaseModel):
    user: User
    recipe_user_id: RecipeUserId

    @field_serializer("user")
    def serialize_user(self, user: User):
        return user.to_json()

    @field_serializer("recipe_user_id")
    def serialize_recipe_user_id(self, rui: RecipeUserId):
        return rui.get_as_string()

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var recipe_user_id : RecipeUserId

The type of the None singleton.

var user : User

The type of the None singleton.

Methods

def serialize_recipe_user_id(self, rui: RecipeUserId)

def serialize_user(self, user: User)

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class SignUpReponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class SignUpReponse(OkResponseBaseModel):
    user: User
    recipe_user_id: RecipeUserId

    @field_serializer("user")
    def serialize_user(self, user: User):
        return user.to_json()

    @field_serializer("recipe_user_id")
    def serialize_recipe_user_id(self, rui: RecipeUserId):
        return rui.get_as_string()

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var recipe_user_id : RecipeUserId

The type of the None singleton.

var user : User

The type of the None singleton.

Methods

def serialize_recipe_user_id(self, rui: RecipeUserId)

def serialize_user(self, user: User)

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class UnknownUserIdErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class UnknownUserIdErrorResponse(
    StatusResponseBaseModel[Literal["UNKNOWN_USER_ID_ERROR"]]
):
    status: Literal["UNKNOWN_USER_ID_ERROR"] = "UNKNOWN_USER_ID_ERROR"

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['UNKNOWN_USER_ID_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var model_config

The type of the None singleton.

var status : Literal['UNKNOWN_USER_ID_ERROR']

The type of the None singleton.

class GenerateRecoverAccountTokenErrorResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class UnknownUserIdErrorResponse(
    StatusResponseBaseModel[Literal["UNKNOWN_USER_ID_ERROR"]]
):
    status: Literal["UNKNOWN_USER_ID_ERROR"] = "UNKNOWN_USER_ID_ERROR"

Ancestors

• supertokens_python.types.response.StatusResponseBaseModel[Literal['UNKNOWN_USER_ID_ERROR']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Inherited members

• StatusResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json

class VerifyCredentialsResponse (**data: Any)

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

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class VerifyCredentialsResponse(OkResponseBaseModel):
    user: User
    recipe_user_id: RecipeUserId

    @field_serializer("user")
    def serialize_user(self, user: User):
        return user.to_json()

    @field_serializer("recipe_user_id")
    def serialize_recipe_user_id(self, rui: RecipeUserId):
        return rui.get_as_string()

Ancestors

• OkResponseBaseModel
• StatusResponseBaseModel[Literal['OK']]
• StatusResponseBaseModel
• CamelCaseBaseModel
• APIResponse
• abc.ABC
• pydantic.main.BaseModel
• typing.Generic

Class variables

var recipe_user_id : RecipeUserId

The type of the None singleton.

var user : User

The type of the None singleton.

Methods

def serialize_recipe_user_id(self, rui: RecipeUserId)

def serialize_user(self, user: User)

Inherited members

• OkResponseBaseModel:
  • from_json
  • model_config
  • status
  • to_json