Namespace supertokens_python.recipe.dashboard.api.multitenancy
+Module supertokens_python.recipe.dashboard.api.multitenancy
Module supertokens_python.recipe.dashboard.api.user.crea
_: APIInterface,
tenant_id: str,
api_options: APIOptions,
- user_context: Dict[str, Any],
+ __: Dict[str, Any],
) -> Union[
CreateEmailPasswordUserOkResponse,
CreateEmailPasswordUserFeatureNotEnabledResponse,
@@ -164,7 +164,7 @@ Module supertokens_python.recipe.dashboard.api.user.crea
Functions
-async def create_email_password_user(_: APIInterface, tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[CreateEmailPasswordUserOkResponse, CreateEmailPasswordUserFeatureNotEnabledResponse, CreateEmailPasswordUserEmailAlreadyExistsResponse, CreateEmailPasswordUserEmailValidationErrorResponse, CreateEmailPasswordUserPasswordValidationErrorResponse]
+async def create_email_password_user(_: APIInterface, tenant_id: str, api_options: APIOptions, __: Dict[str, Any]) ‑> Union[CreateEmailPasswordUserOkResponse, CreateEmailPasswordUserFeatureNotEnabledResponse, CreateEmailPasswordUserEmailAlreadyExistsResponse, CreateEmailPasswordUserEmailValidationErrorResponse, CreateEmailPasswordUserPasswordValidationErrorResponse]
-
@@ -176,7 +176,7 @@
Functions
_: APIInterface,
tenant_id: str,
api_options: APIOptions,
- user_context: Dict[str, Any],
+ __: Dict[str, Any],
) -> Union[
CreateEmailPasswordUserOkResponse,
CreateEmailPasswordUserFeatureNotEnabledResponse,
diff --git a/html/supertokens_python/recipe/dashboard/api/user/create/index.html b/html/supertokens_python/recipe/dashboard/api/user/create/index.html
index fa0f4b49..fe005694 100644
--- a/html/supertokens_python/recipe/dashboard/api/user/create/index.html
+++ b/html/supertokens_python/recipe/dashboard/api/user/create/index.html
@@ -19,7 +19,7 @@
-Namespace supertokens_python.recipe.dashboard.api.user.create
+Module supertokens_python.recipe.dashboard.api.user.create
diff --git a/html/supertokens_python/recipe/dashboard/api/user/create/passwordless_user.html b/html/supertokens_python/recipe/dashboard/api/user/create/passwordless_user.html
index 9a2de743..56183597 100644
--- a/html/supertokens_python/recipe/dashboard/api/user/create/passwordless_user.html
+++ b/html/supertokens_python/recipe/dashboard/api/user/create/passwordless_user.html
@@ -133,9 +133,9 @@ Module supertokens_python.recipe.dashboard.api.user.crea
raise BadInputError("Please provide exactly one of email or phoneNumber")
if email is not None and (
- isinstance(passwordless_recipe.config.contact_config, ContactEmailOnlyConfig)
- or isinstance(
- passwordless_recipe.config.contact_config, ContactEmailOrPhoneConfig
+ isinstance(
+ passwordless_recipe.config.contact_config,
+ (ContactEmailOnlyConfig, ContactEmailOrPhoneConfig),
)
):
email = email.strip()
@@ -148,9 +148,9 @@ Module supertokens_python.recipe.dashboard.api.user.crea
return CreatePasswordlessUserEmailValidationErrorResponse(validation_error)
if phone_number is not None and (
- isinstance(passwordless_recipe.config.contact_config, ContactPhoneOnlyConfig)
- or isinstance(
- passwordless_recipe.config.contact_config, ContactEmailOrPhoneConfig
+ isinstance(
+ passwordless_recipe.config.contact_config,
+ (ContactPhoneOnlyConfig, ContactEmailOrPhoneConfig),
)
):
validation_error = (
@@ -224,9 +224,9 @@ Functions
raise BadInputError("Please provide exactly one of email or phoneNumber")
if email is not None and (
- isinstance(passwordless_recipe.config.contact_config, ContactEmailOnlyConfig)
- or isinstance(
- passwordless_recipe.config.contact_config, ContactEmailOrPhoneConfig
+ isinstance(
+ passwordless_recipe.config.contact_config,
+ (ContactEmailOnlyConfig, ContactEmailOrPhoneConfig),
)
):
email = email.strip()
@@ -239,9 +239,9 @@ Functions
return CreatePasswordlessUserEmailValidationErrorResponse(validation_error)
if phone_number is not None and (
- isinstance(passwordless_recipe.config.contact_config, ContactPhoneOnlyConfig)
- or isinstance(
- passwordless_recipe.config.contact_config, ContactEmailOrPhoneConfig
+ isinstance(
+ passwordless_recipe.config.contact_config,
+ (ContactPhoneOnlyConfig, ContactEmailOrPhoneConfig),
)
):
validation_error = (
diff --git a/html/supertokens_python/recipe/dashboard/api/user/index.html b/html/supertokens_python/recipe/dashboard/api/user/index.html
index 3c3089c9..10a3ae0b 100644
--- a/html/supertokens_python/recipe/dashboard/api/user/index.html
+++ b/html/supertokens_python/recipe/dashboard/api/user/index.html
@@ -19,7 +19,7 @@
-Namespace supertokens_python.recipe.dashboard.api.user
+Module supertokens_python.recipe.dashboard.api.user
diff --git a/html/supertokens_python/recipe/dashboard/api/userroles/index.html b/html/supertokens_python/recipe/dashboard/api/userroles/index.html
index d2623763..ea72d6f7 100644
--- a/html/supertokens_python/recipe/dashboard/api/userroles/index.html
+++ b/html/supertokens_python/recipe/dashboard/api/userroles/index.html
@@ -19,7 +19,7 @@
-Namespace supertokens_python.recipe.dashboard.api.userroles
+Module supertokens_python.recipe.dashboard.api.userroles
diff --git a/html/supertokens_python/recipe/dashboard/api/userroles/permissions/get_permissions_for_role.html b/html/supertokens_python/recipe/dashboard/api/userroles/permissions/get_permissions_for_role.html
index c4fecb20..8f87dec5 100644
--- a/html/supertokens_python/recipe/dashboard/api/userroles/permissions/get_permissions_for_role.html
+++ b/html/supertokens_python/recipe/dashboard/api/userroles/permissions/get_permissions_for_role.html
@@ -34,7 +34,6 @@ Module supertokens_python.recipe.dashboard.api.userroles
GetPermissionsForRoleOkResult,
)
-from supertokens_python.recipe.userroles.recipe import UserRolesRecipe
from supertokens_python.recipe.userroles.recipe import UserRolesRecipe
from supertokens_python.types import APIResponse
@@ -65,10 +64,10 @@ Module supertokens_python.recipe.dashboard.api.userroles
async def get_permissions_for_role_api(
- _api_interface: APIInterface,
- _tenant_id: str,
+ _: APIInterface,
+ __: str,
api_options: APIOptions,
- user_context: Dict[str, Any],
+ ___: Dict[str, Any],
) -> Union[
OkPermissionsForRoleResponse,
FeatureNotEnabledErrorResponse,
@@ -100,7 +99,7 @@ Module supertokens_python.recipe.dashboard.api.userroles
Functions
-async def get_permissions_for_role_api(_api_interface: APIInterface, _tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[OkPermissionsForRoleResponse, FeatureNotEnabledErrorResponse, UnknownRoleErrorResponse]
+async def get_permissions_for_role_api(_: APIInterface, __: str, api_options: APIOptions, ___: Dict[str, Any]) ‑> Union[OkPermissionsForRoleResponse, FeatureNotEnabledErrorResponse, UnknownRoleErrorResponse]
-
@@ -109,10 +108,10 @@
Functions
Expand source code
async def get_permissions_for_role_api(
- _api_interface: APIInterface,
- _tenant_id: str,
+ _: APIInterface,
+ __: str,
api_options: APIOptions,
- user_context: Dict[str, Any],
+ ___: Dict[str, Any],
) -> Union[
OkPermissionsForRoleResponse,
FeatureNotEnabledErrorResponse,
diff --git a/html/supertokens_python/recipe/dashboard/api/userroles/permissions/index.html b/html/supertokens_python/recipe/dashboard/api/userroles/permissions/index.html
index 81dc595e..398dce66 100644
--- a/html/supertokens_python/recipe/dashboard/api/userroles/permissions/index.html
+++ b/html/supertokens_python/recipe/dashboard/api/userroles/permissions/index.html
@@ -19,7 +19,7 @@
-Namespace supertokens_python.recipe.dashboard.api.userroles.permissions
+Module supertokens_python.recipe.dashboard.api.userroles.permissions
diff --git a/html/supertokens_python/recipe/dashboard/api/userroles/roles/get_all_roles.html b/html/supertokens_python/recipe/dashboard/api/userroles/roles/get_all_roles.html
index 2c4d4081..183e5ba8 100644
--- a/html/supertokens_python/recipe/dashboard/api/userroles/roles/get_all_roles.html
+++ b/html/supertokens_python/recipe/dashboard/api/userroles/roles/get_all_roles.html
@@ -52,7 +52,7 @@ Module supertokens_python.recipe.dashboard.api.userroles
async def get_all_roles_api(
- _: APIInterface, __: str, api_options: APIOptions, ___: Any
+ _: APIInterface, __: str, ___: APIOptions, ____: Any
) -> Union[OkResponse, FeatureNotEnabledErrorResponse]:
try:
UserRolesRecipe.get_instance()
@@ -71,7 +71,7 @@ Module supertokens_python.recipe.dashboard.api.userroles
Functions
-async def get_all_roles_api(_: APIInterface, __: str, api_options: APIOptions, ___: Any) ‑> Union[OkResponse, FeatureNotEnabledErrorResponse]
+async def get_all_roles_api(_: APIInterface, __: str, ___: APIOptions, ____: Any) ‑> Union[OkResponse, FeatureNotEnabledErrorResponse]
-
@@ -80,7 +80,7 @@
Functions
Expand source code
async def get_all_roles_api(
- _: APIInterface, __: str, api_options: APIOptions, ___: Any
+ _: APIInterface, __: str, ___: APIOptions, ____: Any
) -> Union[OkResponse, FeatureNotEnabledErrorResponse]:
try:
UserRolesRecipe.get_instance()
diff --git a/html/supertokens_python/recipe/dashboard/api/userroles/roles/index.html b/html/supertokens_python/recipe/dashboard/api/userroles/roles/index.html
index 7835f686..35663a9f 100644
--- a/html/supertokens_python/recipe/dashboard/api/userroles/roles/index.html
+++ b/html/supertokens_python/recipe/dashboard/api/userroles/roles/index.html
@@ -19,7 +19,7 @@
-Namespace supertokens_python.recipe.dashboard.api.userroles.roles
+Module supertokens_python.recipe.dashboard.api.userroles.roles
diff --git a/html/supertokens_python/recipe/totp/api/create_device.html b/html/supertokens_python/recipe/totp/api/create_device.html
index f469f709..87333c08 100644
--- a/html/supertokens_python/recipe/totp/api/create_device.html
+++ b/html/supertokens_python/recipe/totp/api/create_device.html
@@ -54,7 +54,7 @@ Module supertokens_python.recipe.totp.api.create_device<
async def handle_create_device_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
@@ -94,7 +94,7 @@ Module supertokens_python.recipe.totp.api.create_device<
Functions
-async def handle_create_device_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+async def handle_create_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -103,7 +103,7 @@
Functions
Expand source code
async def handle_create_device_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
diff --git a/html/supertokens_python/recipe/totp/api/index.html b/html/supertokens_python/recipe/totp/api/index.html
index 03a20cc2..92f04a5c 100644
--- a/html/supertokens_python/recipe/totp/api/index.html
+++ b/html/supertokens_python/recipe/totp/api/index.html
@@ -19,9 +19,40 @@
-Namespace supertokens_python.recipe.totp.api
+Module supertokens_python.recipe.totp.api
+
+
+Expand source code
+
+# Copyright (c) 2024, VRAI Labs and/or its affiliates. All rights reserved.
+#
+# This software is licensed under the Apache License, Version 2.0 (the
+# "License") as published by the Apache Software Foundation.
+#
+# You may not use this file except in compliance with the License. You may
+# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+from .create_device import handle_create_device_api
+from .list_devices import handle_list_devices_api
+from .remove_device import handle_remove_device_api
+from .verify_device import handle_verify_device_api
+from .verify_totp import handle_verify_totp_api
+
+__all__ = [
+ "handle_create_device_api",
+ "handle_list_devices_api",
+ "handle_remove_device_api",
+ "handle_verify_device_api",
+ "handle_verify_totp_api",
+]
+
Sub-modules
@@ -55,6 +86,227 @@ Sub-modules
+Functions
+
+
+async def handle_create_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+
+-
+
+
+
+Expand source code
+
+async def handle_create_device_api(
+ _: str,
+ api_implementation: APIInterface,
+ api_options: APIOptions,
+ user_context: Dict[str, Any],
+) -> Union[BaseResponse, None]:
+ if api_implementation.disable_create_device_post:
+ return None
+
+ session = await get_session(
+ api_options.request,
+ override_global_claim_validators=lambda _, __, ___: [],
+ user_context=user_context,
+ )
+
+ assert session is not None
+
+ body = await api_options.request.json()
+ if body is None:
+ raise_bad_input_exception("Please provide a JSON body")
+
+ device_name = body.get("deviceName")
+
+ if device_name is not None and not isinstance(device_name, str):
+ raise_bad_input_exception("deviceName must be a string")
+
+ response = await api_implementation.create_device_post(
+ device_name, api_options, session, user_context
+ )
+
+ return send_200_response(response.to_json(), api_options.response)
+
+
+
+async def handle_list_devices_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+
+-
+
+
+
+Expand source code
+
+async def handle_list_devices_api(
+ _: str,
+ api_implementation: APIInterface,
+ api_options: APIOptions,
+ user_context: Dict[str, Any],
+) -> Union[BaseResponse, None]:
+ if api_implementation.disable_list_devices_get:
+ return None
+
+ session = await get_session(
+ api_options.request,
+ override_global_claim_validators=lambda _, __, ___: [],
+ session_required=True,
+ user_context=user_context,
+ )
+
+ assert session is not None
+
+ response = await api_implementation.list_devices_get(
+ api_options, session, user_context
+ )
+
+ return send_200_response(response.to_json(), api_options.response)
+
+
+
+async def handle_remove_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+
+-
+
+
+
+Expand source code
+
+async def handle_remove_device_api(
+ _: str,
+ api_implementation: APIInterface,
+ api_options: APIOptions,
+ user_context: Dict[str, Any],
+) -> Union[BaseResponse, None]:
+ if api_implementation.disable_remove_device_post:
+ return None
+
+ session = await get_session(
+ api_options.request,
+ override_global_claim_validators=lambda _, __, ___: [],
+ session_required=True,
+ user_context=user_context,
+ )
+
+ assert session is not None
+
+ body = await api_options.request.json()
+ if body is None:
+ raise_bad_input_exception("Please provide a JSON body")
+ device_name = body.get("deviceName")
+
+ if device_name is None or not isinstance(device_name, str) or len(device_name) == 0:
+ raise Exception("deviceName is required and must be a non-empty string")
+
+ response = await api_implementation.remove_device_post(
+ device_name=device_name,
+ options=api_options,
+ session=session,
+ user_context=user_context,
+ )
+
+ return send_200_response(response.to_json(), api_options.response)
+
+
+
+async def handle_verify_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+
+-
+
+
+
+Expand source code
+
+async def handle_verify_device_api(
+ _: str,
+ api_implementation: APIInterface,
+ api_options: APIOptions,
+ user_context: Dict[str, Any],
+) -> Union[BaseResponse, None]:
+ if api_implementation.disable_verify_device_post:
+ return None
+
+ session = await get_session(
+ api_options.request,
+ override_global_claim_validators=lambda _, __, ___: [],
+ session_required=True,
+ user_context=user_context,
+ )
+
+ assert session is not None
+
+ body = await api_options.request.json()
+ if body is None:
+ raise_bad_input_exception("Please provide a JSON body")
+
+ device_name = body.get("deviceName")
+ totp = body.get("totp")
+
+ if device_name is None or not isinstance(device_name, str):
+ raise Exception("deviceName is required and must be a string")
+
+ if totp is None or not isinstance(totp, str):
+ raise Exception("totp is required and must be a string")
+
+ response = await api_implementation.verify_device_post(
+ device_name=device_name,
+ totp=totp,
+ options=api_options,
+ session=session,
+ user_context=user_context,
+ )
+
+ return send_200_response(response.to_json(), api_options.response)
+
+
+
+async def handle_verify_totp_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+
+-
+
+
+
+Expand source code
+
+async def handle_verify_totp_api(
+ _: str,
+ api_implementation: APIInterface,
+ api_options: APIOptions,
+ user_context: Dict[str, Any],
+) -> Union[BaseResponse, None]:
+ if api_implementation.disable_verify_totp_post:
+ return None
+
+ session = await get_session(
+ api_options.request,
+ override_global_claim_validators=lambda _, __, ___: [],
+ session_required=True,
+ user_context=user_context,
+ )
+
+ assert session is not None
+
+ body = await api_options.request.json()
+ if body is None:
+ raise_bad_input_exception("Please provide a JSON body")
+
+ totp = body.get("totp")
+
+ if totp is None or not isinstance(totp, str):
+ raise Exception("totp is required and must be a string")
+
+ response = await api_implementation.verify_totp_post(
+ totp=totp,
+ options=api_options,
+ session=session,
+ user_context=user_context,
+ )
+
+ return send_200_response(response.to_json(), api_options.response)
+
+
+
@@ -80,6 +332,15 @@ Index
supertokens_python.recipe.totp.api.verify_totp
+Functions
+
+
diff --git a/html/supertokens_python/recipe/totp/api/list_devices.html b/html/supertokens_python/recipe/totp/api/list_devices.html
index e3d75ad3..e4f1567a 100644
--- a/html/supertokens_python/recipe/totp/api/list_devices.html
+++ b/html/supertokens_python/recipe/totp/api/list_devices.html
@@ -52,7 +52,7 @@ Module supertokens_python.recipe.totp.api.list_devices
async def handle_list_devices_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
@@ -84,7 +84,7 @@ Module supertokens_python.recipe.totp.api.list_devices
Functions
-async def handle_list_devices_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+async def handle_list_devices_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -93,7 +93,7 @@
Functions
Expand source code
async def handle_list_devices_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
diff --git a/html/supertokens_python/recipe/totp/api/remove_device.html b/html/supertokens_python/recipe/totp/api/remove_device.html
index 728a7351..4ec68002 100644
--- a/html/supertokens_python/recipe/totp/api/remove_device.html
+++ b/html/supertokens_python/recipe/totp/api/remove_device.html
@@ -53,7 +53,7 @@ Module supertokens_python.recipe.totp.api.remove_device<
async def handle_remove_device_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
@@ -96,7 +96,7 @@ Module supertokens_python.recipe.totp.api.remove_device<
Functions
-async def handle_remove_device_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+async def handle_remove_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -105,7 +105,7 @@
Functions
Expand source code
async def handle_remove_device_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
diff --git a/html/supertokens_python/recipe/totp/api/verify_device.html b/html/supertokens_python/recipe/totp/api/verify_device.html
index 1392a5ec..290b9335 100644
--- a/html/supertokens_python/recipe/totp/api/verify_device.html
+++ b/html/supertokens_python/recipe/totp/api/verify_device.html
@@ -53,7 +53,7 @@ Module supertokens_python.recipe.totp.api.verify_device<
async def handle_verify_device_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
@@ -102,7 +102,7 @@ Module supertokens_python.recipe.totp.api.verify_device<
Functions
-async def handle_verify_device_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+async def handle_verify_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -111,7 +111,7 @@
Functions
Expand source code
async def handle_verify_device_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
diff --git a/html/supertokens_python/recipe/totp/api/verify_totp.html b/html/supertokens_python/recipe/totp/api/verify_totp.html
index 3f240d97..9feb92ab 100644
--- a/html/supertokens_python/recipe/totp/api/verify_totp.html
+++ b/html/supertokens_python/recipe/totp/api/verify_totp.html
@@ -53,7 +53,7 @@ Module supertokens_python.recipe.totp.api.verify_totpModule supertokens_python.recipe.totp.api.verify_totpFunctions
-async def handle_verify_totp_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+async def handle_verify_totp_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -106,7 +106,7 @@
Functions
Expand source code
async def handle_verify_totp_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
Module supertokens_python.recipe.dashboard.api.user.crea
Functions
-async def create_email_password_user(_: APIInterface, tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[CreateEmailPasswordUserOkResponse, CreateEmailPasswordUserFeatureNotEnabledResponse, CreateEmailPasswordUserEmailAlreadyExistsResponse, CreateEmailPasswordUserEmailValidationErrorResponse, CreateEmailPasswordUserPasswordValidationErrorResponse]
+async def create_email_password_user(_: APIInterface, tenant_id: str, api_options: APIOptions, __: Dict[str, Any]) ‑> Union[CreateEmailPasswordUserOkResponse, CreateEmailPasswordUserFeatureNotEnabledResponse, CreateEmailPasswordUserEmailAlreadyExistsResponse, CreateEmailPasswordUserEmailValidationErrorResponse, CreateEmailPasswordUserPasswordValidationErrorResponse]
-
@@ -176,7 +176,7 @@
Functions
_: APIInterface,
tenant_id: str,
api_options: APIOptions,
- user_context: Dict[str, Any],
+ __: Dict[str, Any],
) -> Union[
CreateEmailPasswordUserOkResponse,
CreateEmailPasswordUserFeatureNotEnabledResponse,
diff --git a/html/supertokens_python/recipe/dashboard/api/user/create/index.html b/html/supertokens_python/recipe/dashboard/api/user/create/index.html
index fa0f4b49..fe005694 100644
--- a/html/supertokens_python/recipe/dashboard/api/user/create/index.html
+++ b/html/supertokens_python/recipe/dashboard/api/user/create/index.html
@@ -19,7 +19,7 @@
-Namespace supertokens_python.recipe.dashboard.api.user.create
+Module supertokens_python.recipe.dashboard.api.user.create
diff --git a/html/supertokens_python/recipe/dashboard/api/user/create/passwordless_user.html b/html/supertokens_python/recipe/dashboard/api/user/create/passwordless_user.html
index 9a2de743..56183597 100644
--- a/html/supertokens_python/recipe/dashboard/api/user/create/passwordless_user.html
+++ b/html/supertokens_python/recipe/dashboard/api/user/create/passwordless_user.html
@@ -133,9 +133,9 @@ Module supertokens_python.recipe.dashboard.api.user.crea
raise BadInputError("Please provide exactly one of email or phoneNumber")
if email is not None and (
- isinstance(passwordless_recipe.config.contact_config, ContactEmailOnlyConfig)
- or isinstance(
- passwordless_recipe.config.contact_config, ContactEmailOrPhoneConfig
+ isinstance(
+ passwordless_recipe.config.contact_config,
+ (ContactEmailOnlyConfig, ContactEmailOrPhoneConfig),
)
):
email = email.strip()
@@ -148,9 +148,9 @@ Module supertokens_python.recipe.dashboard.api.user.crea
return CreatePasswordlessUserEmailValidationErrorResponse(validation_error)
if phone_number is not None and (
- isinstance(passwordless_recipe.config.contact_config, ContactPhoneOnlyConfig)
- or isinstance(
- passwordless_recipe.config.contact_config, ContactEmailOrPhoneConfig
+ isinstance(
+ passwordless_recipe.config.contact_config,
+ (ContactPhoneOnlyConfig, ContactEmailOrPhoneConfig),
)
):
validation_error = (
@@ -224,9 +224,9 @@ Functions
raise BadInputError("Please provide exactly one of email or phoneNumber")
if email is not None and (
- isinstance(passwordless_recipe.config.contact_config, ContactEmailOnlyConfig)
- or isinstance(
- passwordless_recipe.config.contact_config, ContactEmailOrPhoneConfig
+ isinstance(
+ passwordless_recipe.config.contact_config,
+ (ContactEmailOnlyConfig, ContactEmailOrPhoneConfig),
)
):
email = email.strip()
@@ -239,9 +239,9 @@ Functions
return CreatePasswordlessUserEmailValidationErrorResponse(validation_error)
if phone_number is not None and (
- isinstance(passwordless_recipe.config.contact_config, ContactPhoneOnlyConfig)
- or isinstance(
- passwordless_recipe.config.contact_config, ContactEmailOrPhoneConfig
+ isinstance(
+ passwordless_recipe.config.contact_config,
+ (ContactPhoneOnlyConfig, ContactEmailOrPhoneConfig),
)
):
validation_error = (
diff --git a/html/supertokens_python/recipe/dashboard/api/user/index.html b/html/supertokens_python/recipe/dashboard/api/user/index.html
index 3c3089c9..10a3ae0b 100644
--- a/html/supertokens_python/recipe/dashboard/api/user/index.html
+++ b/html/supertokens_python/recipe/dashboard/api/user/index.html
@@ -19,7 +19,7 @@
-Namespace supertokens_python.recipe.dashboard.api.user
+Module supertokens_python.recipe.dashboard.api.user
diff --git a/html/supertokens_python/recipe/dashboard/api/userroles/index.html b/html/supertokens_python/recipe/dashboard/api/userroles/index.html
index d2623763..ea72d6f7 100644
--- a/html/supertokens_python/recipe/dashboard/api/userroles/index.html
+++ b/html/supertokens_python/recipe/dashboard/api/userroles/index.html
@@ -19,7 +19,7 @@
-Namespace supertokens_python.recipe.dashboard.api.userroles
+Module supertokens_python.recipe.dashboard.api.userroles
diff --git a/html/supertokens_python/recipe/dashboard/api/userroles/permissions/get_permissions_for_role.html b/html/supertokens_python/recipe/dashboard/api/userroles/permissions/get_permissions_for_role.html
index c4fecb20..8f87dec5 100644
--- a/html/supertokens_python/recipe/dashboard/api/userroles/permissions/get_permissions_for_role.html
+++ b/html/supertokens_python/recipe/dashboard/api/userroles/permissions/get_permissions_for_role.html
@@ -34,7 +34,6 @@ Module supertokens_python.recipe.dashboard.api.userroles
GetPermissionsForRoleOkResult,
)
-from supertokens_python.recipe.userroles.recipe import UserRolesRecipe
from supertokens_python.recipe.userroles.recipe import UserRolesRecipe
from supertokens_python.types import APIResponse
@@ -65,10 +64,10 @@ Module supertokens_python.recipe.dashboard.api.userroles
async def get_permissions_for_role_api(
- _api_interface: APIInterface,
- _tenant_id: str,
+ _: APIInterface,
+ __: str,
api_options: APIOptions,
- user_context: Dict[str, Any],
+ ___: Dict[str, Any],
) -> Union[
OkPermissionsForRoleResponse,
FeatureNotEnabledErrorResponse,
@@ -100,7 +99,7 @@ Module supertokens_python.recipe.dashboard.api.userroles
Functions
-async def get_permissions_for_role_api(_api_interface: APIInterface, _tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[OkPermissionsForRoleResponse, FeatureNotEnabledErrorResponse, UnknownRoleErrorResponse]
+async def get_permissions_for_role_api(_: APIInterface, __: str, api_options: APIOptions, ___: Dict[str, Any]) ‑> Union[OkPermissionsForRoleResponse, FeatureNotEnabledErrorResponse, UnknownRoleErrorResponse]
-
@@ -109,10 +108,10 @@
Functions
Expand source code
async def get_permissions_for_role_api(
- _api_interface: APIInterface,
- _tenant_id: str,
+ _: APIInterface,
+ __: str,
api_options: APIOptions,
- user_context: Dict[str, Any],
+ ___: Dict[str, Any],
) -> Union[
OkPermissionsForRoleResponse,
FeatureNotEnabledErrorResponse,
diff --git a/html/supertokens_python/recipe/dashboard/api/userroles/permissions/index.html b/html/supertokens_python/recipe/dashboard/api/userroles/permissions/index.html
index 81dc595e..398dce66 100644
--- a/html/supertokens_python/recipe/dashboard/api/userroles/permissions/index.html
+++ b/html/supertokens_python/recipe/dashboard/api/userroles/permissions/index.html
@@ -19,7 +19,7 @@
-Namespace supertokens_python.recipe.dashboard.api.userroles.permissions
+Module supertokens_python.recipe.dashboard.api.userroles.permissions
diff --git a/html/supertokens_python/recipe/dashboard/api/userroles/roles/get_all_roles.html b/html/supertokens_python/recipe/dashboard/api/userroles/roles/get_all_roles.html
index 2c4d4081..183e5ba8 100644
--- a/html/supertokens_python/recipe/dashboard/api/userroles/roles/get_all_roles.html
+++ b/html/supertokens_python/recipe/dashboard/api/userroles/roles/get_all_roles.html
@@ -52,7 +52,7 @@ Module supertokens_python.recipe.dashboard.api.userroles
async def get_all_roles_api(
- _: APIInterface, __: str, api_options: APIOptions, ___: Any
+ _: APIInterface, __: str, ___: APIOptions, ____: Any
) -> Union[OkResponse, FeatureNotEnabledErrorResponse]:
try:
UserRolesRecipe.get_instance()
@@ -71,7 +71,7 @@ Module supertokens_python.recipe.dashboard.api.userroles
Functions
-async def get_all_roles_api(_: APIInterface, __: str, api_options: APIOptions, ___: Any) ‑> Union[OkResponse, FeatureNotEnabledErrorResponse]
+async def get_all_roles_api(_: APIInterface, __: str, ___: APIOptions, ____: Any) ‑> Union[OkResponse, FeatureNotEnabledErrorResponse]
-
@@ -80,7 +80,7 @@
Functions
Expand source code
async def get_all_roles_api(
- _: APIInterface, __: str, api_options: APIOptions, ___: Any
+ _: APIInterface, __: str, ___: APIOptions, ____: Any
) -> Union[OkResponse, FeatureNotEnabledErrorResponse]:
try:
UserRolesRecipe.get_instance()
diff --git a/html/supertokens_python/recipe/dashboard/api/userroles/roles/index.html b/html/supertokens_python/recipe/dashboard/api/userroles/roles/index.html
index 7835f686..35663a9f 100644
--- a/html/supertokens_python/recipe/dashboard/api/userroles/roles/index.html
+++ b/html/supertokens_python/recipe/dashboard/api/userroles/roles/index.html
@@ -19,7 +19,7 @@
-Namespace supertokens_python.recipe.dashboard.api.userroles.roles
+Module supertokens_python.recipe.dashboard.api.userroles.roles
diff --git a/html/supertokens_python/recipe/totp/api/create_device.html b/html/supertokens_python/recipe/totp/api/create_device.html
index f469f709..87333c08 100644
--- a/html/supertokens_python/recipe/totp/api/create_device.html
+++ b/html/supertokens_python/recipe/totp/api/create_device.html
@@ -54,7 +54,7 @@ Module supertokens_python.recipe.totp.api.create_device<
async def handle_create_device_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
@@ -94,7 +94,7 @@ Module supertokens_python.recipe.totp.api.create_device<
Functions
-async def handle_create_device_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+async def handle_create_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -103,7 +103,7 @@
Functions
Expand source code
async def handle_create_device_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
diff --git a/html/supertokens_python/recipe/totp/api/index.html b/html/supertokens_python/recipe/totp/api/index.html
index 03a20cc2..92f04a5c 100644
--- a/html/supertokens_python/recipe/totp/api/index.html
+++ b/html/supertokens_python/recipe/totp/api/index.html
@@ -19,9 +19,40 @@
-Namespace supertokens_python.recipe.totp.api
+Module supertokens_python.recipe.totp.api
+
+
+Expand source code
+
+# Copyright (c) 2024, VRAI Labs and/or its affiliates. All rights reserved.
+#
+# This software is licensed under the Apache License, Version 2.0 (the
+# "License") as published by the Apache Software Foundation.
+#
+# You may not use this file except in compliance with the License. You may
+# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+from .create_device import handle_create_device_api
+from .list_devices import handle_list_devices_api
+from .remove_device import handle_remove_device_api
+from .verify_device import handle_verify_device_api
+from .verify_totp import handle_verify_totp_api
+
+__all__ = [
+ "handle_create_device_api",
+ "handle_list_devices_api",
+ "handle_remove_device_api",
+ "handle_verify_device_api",
+ "handle_verify_totp_api",
+]
+
Sub-modules
@@ -55,6 +86,227 @@ Sub-modules
+Functions
+
+
+async def handle_create_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+
+-
+
+
+
+Expand source code
+
+async def handle_create_device_api(
+ _: str,
+ api_implementation: APIInterface,
+ api_options: APIOptions,
+ user_context: Dict[str, Any],
+) -> Union[BaseResponse, None]:
+ if api_implementation.disable_create_device_post:
+ return None
+
+ session = await get_session(
+ api_options.request,
+ override_global_claim_validators=lambda _, __, ___: [],
+ user_context=user_context,
+ )
+
+ assert session is not None
+
+ body = await api_options.request.json()
+ if body is None:
+ raise_bad_input_exception("Please provide a JSON body")
+
+ device_name = body.get("deviceName")
+
+ if device_name is not None and not isinstance(device_name, str):
+ raise_bad_input_exception("deviceName must be a string")
+
+ response = await api_implementation.create_device_post(
+ device_name, api_options, session, user_context
+ )
+
+ return send_200_response(response.to_json(), api_options.response)
+
+
+
+async def handle_list_devices_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+
+-
+
+
+
+Expand source code
+
+async def handle_list_devices_api(
+ _: str,
+ api_implementation: APIInterface,
+ api_options: APIOptions,
+ user_context: Dict[str, Any],
+) -> Union[BaseResponse, None]:
+ if api_implementation.disable_list_devices_get:
+ return None
+
+ session = await get_session(
+ api_options.request,
+ override_global_claim_validators=lambda _, __, ___: [],
+ session_required=True,
+ user_context=user_context,
+ )
+
+ assert session is not None
+
+ response = await api_implementation.list_devices_get(
+ api_options, session, user_context
+ )
+
+ return send_200_response(response.to_json(), api_options.response)
+
+
+
+async def handle_remove_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+
+-
+
+
+
+Expand source code
+
+async def handle_remove_device_api(
+ _: str,
+ api_implementation: APIInterface,
+ api_options: APIOptions,
+ user_context: Dict[str, Any],
+) -> Union[BaseResponse, None]:
+ if api_implementation.disable_remove_device_post:
+ return None
+
+ session = await get_session(
+ api_options.request,
+ override_global_claim_validators=lambda _, __, ___: [],
+ session_required=True,
+ user_context=user_context,
+ )
+
+ assert session is not None
+
+ body = await api_options.request.json()
+ if body is None:
+ raise_bad_input_exception("Please provide a JSON body")
+ device_name = body.get("deviceName")
+
+ if device_name is None or not isinstance(device_name, str) or len(device_name) == 0:
+ raise Exception("deviceName is required and must be a non-empty string")
+
+ response = await api_implementation.remove_device_post(
+ device_name=device_name,
+ options=api_options,
+ session=session,
+ user_context=user_context,
+ )
+
+ return send_200_response(response.to_json(), api_options.response)
+
+
+
+async def handle_verify_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+
+-
+
+
+
+Expand source code
+
+async def handle_verify_device_api(
+ _: str,
+ api_implementation: APIInterface,
+ api_options: APIOptions,
+ user_context: Dict[str, Any],
+) -> Union[BaseResponse, None]:
+ if api_implementation.disable_verify_device_post:
+ return None
+
+ session = await get_session(
+ api_options.request,
+ override_global_claim_validators=lambda _, __, ___: [],
+ session_required=True,
+ user_context=user_context,
+ )
+
+ assert session is not None
+
+ body = await api_options.request.json()
+ if body is None:
+ raise_bad_input_exception("Please provide a JSON body")
+
+ device_name = body.get("deviceName")
+ totp = body.get("totp")
+
+ if device_name is None or not isinstance(device_name, str):
+ raise Exception("deviceName is required and must be a string")
+
+ if totp is None or not isinstance(totp, str):
+ raise Exception("totp is required and must be a string")
+
+ response = await api_implementation.verify_device_post(
+ device_name=device_name,
+ totp=totp,
+ options=api_options,
+ session=session,
+ user_context=user_context,
+ )
+
+ return send_200_response(response.to_json(), api_options.response)
+
+
+
+async def handle_verify_totp_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+
+-
+
+
+
+Expand source code
+
+async def handle_verify_totp_api(
+ _: str,
+ api_implementation: APIInterface,
+ api_options: APIOptions,
+ user_context: Dict[str, Any],
+) -> Union[BaseResponse, None]:
+ if api_implementation.disable_verify_totp_post:
+ return None
+
+ session = await get_session(
+ api_options.request,
+ override_global_claim_validators=lambda _, __, ___: [],
+ session_required=True,
+ user_context=user_context,
+ )
+
+ assert session is not None
+
+ body = await api_options.request.json()
+ if body is None:
+ raise_bad_input_exception("Please provide a JSON body")
+
+ totp = body.get("totp")
+
+ if totp is None or not isinstance(totp, str):
+ raise Exception("totp is required and must be a string")
+
+ response = await api_implementation.verify_totp_post(
+ totp=totp,
+ options=api_options,
+ session=session,
+ user_context=user_context,
+ )
+
+ return send_200_response(response.to_json(), api_options.response)
+
+
+
@@ -80,6 +332,15 @@ Index
supertokens_python.recipe.totp.api.verify_totp
+Functions
+
+
diff --git a/html/supertokens_python/recipe/totp/api/list_devices.html b/html/supertokens_python/recipe/totp/api/list_devices.html
index e3d75ad3..e4f1567a 100644
--- a/html/supertokens_python/recipe/totp/api/list_devices.html
+++ b/html/supertokens_python/recipe/totp/api/list_devices.html
@@ -52,7 +52,7 @@ Module supertokens_python.recipe.totp.api.list_devices
async def handle_list_devices_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
@@ -84,7 +84,7 @@ Module supertokens_python.recipe.totp.api.list_devices
Functions
-async def handle_list_devices_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+async def handle_list_devices_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -93,7 +93,7 @@
Functions
Expand source code
async def handle_list_devices_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
diff --git a/html/supertokens_python/recipe/totp/api/remove_device.html b/html/supertokens_python/recipe/totp/api/remove_device.html
index 728a7351..4ec68002 100644
--- a/html/supertokens_python/recipe/totp/api/remove_device.html
+++ b/html/supertokens_python/recipe/totp/api/remove_device.html
@@ -53,7 +53,7 @@ Module supertokens_python.recipe.totp.api.remove_device<
async def handle_remove_device_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
@@ -96,7 +96,7 @@ Module supertokens_python.recipe.totp.api.remove_device<
Functions
-async def handle_remove_device_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+async def handle_remove_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -105,7 +105,7 @@
Functions
Expand source code
async def handle_remove_device_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
diff --git a/html/supertokens_python/recipe/totp/api/verify_device.html b/html/supertokens_python/recipe/totp/api/verify_device.html
index 1392a5ec..290b9335 100644
--- a/html/supertokens_python/recipe/totp/api/verify_device.html
+++ b/html/supertokens_python/recipe/totp/api/verify_device.html
@@ -53,7 +53,7 @@ Module supertokens_python.recipe.totp.api.verify_device<
async def handle_verify_device_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
@@ -102,7 +102,7 @@ Module supertokens_python.recipe.totp.api.verify_device<
Functions
-async def handle_verify_device_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+async def handle_verify_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -111,7 +111,7 @@
Functions
Expand source code
async def handle_verify_device_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
diff --git a/html/supertokens_python/recipe/totp/api/verify_totp.html b/html/supertokens_python/recipe/totp/api/verify_totp.html
index 3f240d97..9feb92ab 100644
--- a/html/supertokens_python/recipe/totp/api/verify_totp.html
+++ b/html/supertokens_python/recipe/totp/api/verify_totp.html
@@ -53,7 +53,7 @@ Module supertokens_python.recipe.totp.api.verify_totpModule supertokens_python.recipe.totp.api.verify_totpFunctions
-async def handle_verify_totp_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
+async def handle_verify_totp_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -106,7 +106,7 @@
Functions
Expand source code
async def handle_verify_totp_api(
- tenant_id: str,
+ _: str,
api_implementation: APIInterface,
api_options: APIOptions,
user_context: Dict[str, Any],
Functions
-async def create_email_password_user(_: APIInterface, tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[CreateEmailPasswordUserOkResponse, CreateEmailPasswordUserFeatureNotEnabledResponse, CreateEmailPasswordUserEmailAlreadyExistsResponse, CreateEmailPasswordUserEmailValidationErrorResponse, CreateEmailPasswordUserPasswordValidationErrorResponse] +async def create_email_password_user(_: APIInterface, tenant_id: str, api_options: APIOptions, __: Dict[str, Any]) ‑> Union[CreateEmailPasswordUserOkResponse, CreateEmailPasswordUserFeatureNotEnabledResponse, CreateEmailPasswordUserEmailAlreadyExistsResponse, CreateEmailPasswordUserEmailValidationErrorResponse, CreateEmailPasswordUserPasswordValidationErrorResponse]
-
@@ -176,7 +176,7 @@
Functions
_: APIInterface, tenant_id: str, api_options: APIOptions, - user_context: Dict[str, Any], + __: Dict[str, Any], ) -> Union[ CreateEmailPasswordUserOkResponse, CreateEmailPasswordUserFeatureNotEnabledResponse, diff --git a/html/supertokens_python/recipe/dashboard/api/user/create/index.html b/html/supertokens_python/recipe/dashboard/api/user/create/index.html index fa0f4b49..fe005694 100644 --- a/html/supertokens_python/recipe/dashboard/api/user/create/index.html +++ b/html/supertokens_python/recipe/dashboard/api/user/create/index.html @@ -19,7 +19,7 @@- Namespace
+supertokens_python.recipe.dashboard.api.user.create
Module
supertokens_python.recipe.dashboard.api.user.create
Module
supertokens_python.recipe.dashboard.api.user.crea raise BadInputError("Please provide exactly one of email or phoneNumber") if email is not None and ( - isinstance(passwordless_recipe.config.contact_config, ContactEmailOnlyConfig) - or isinstance( - passwordless_recipe.config.contact_config, ContactEmailOrPhoneConfig + isinstance( + passwordless_recipe.config.contact_config, + (ContactEmailOnlyConfig, ContactEmailOrPhoneConfig), ) ): email = email.strip() @@ -148,9 +148,9 @@
Module
supertokens_python.recipe.dashboard.api.user.crea return CreatePasswordlessUserEmailValidationErrorResponse(validation_error) if phone_number is not None and ( - isinstance(passwordless_recipe.config.contact_config, ContactPhoneOnlyConfig) - or isinstance( - passwordless_recipe.config.contact_config, ContactEmailOrPhoneConfig + isinstance( + passwordless_recipe.config.contact_config, + (ContactPhoneOnlyConfig, ContactEmailOrPhoneConfig), ) ): validation_error = ( @@ -224,9 +224,9 @@
Functions
raise BadInputError("Please provide exactly one of email or phoneNumber") if email is not None and ( - isinstance(passwordless_recipe.config.contact_config, ContactEmailOnlyConfig) - or isinstance( - passwordless_recipe.config.contact_config, ContactEmailOrPhoneConfig + isinstance( + passwordless_recipe.config.contact_config, + (ContactEmailOnlyConfig, ContactEmailOrPhoneConfig), ) ): email = email.strip() @@ -239,9 +239,9 @@Functions
return CreatePasswordlessUserEmailValidationErrorResponse(validation_error) if phone_number is not None and ( - isinstance(passwordless_recipe.config.contact_config, ContactPhoneOnlyConfig) - or isinstance( - passwordless_recipe.config.contact_config, ContactEmailOrPhoneConfig + isinstance( + passwordless_recipe.config.contact_config, + (ContactPhoneOnlyConfig, ContactEmailOrPhoneConfig), ) ): validation_error = ( diff --git a/html/supertokens_python/recipe/dashboard/api/user/index.html b/html/supertokens_python/recipe/dashboard/api/user/index.html index 3c3089c9..10a3ae0b 100644 --- a/html/supertokens_python/recipe/dashboard/api/user/index.html +++ b/html/supertokens_python/recipe/dashboard/api/user/index.html @@ -19,7 +19,7 @@- Namespace
+supertokens_python.recipe.dashboard.api.user
Module
supertokens_python.recipe.dashboard.api.user
- Namespace
+supertokens_python.recipe.dashboard.api.userroles
Module
supertokens_python.recipe.dashboard.api.userroles
Module
supertokens_python.recipe.dashboard.api.userroles GetPermissionsForRoleOkResult, ) -from supertokens_python.recipe.userroles.recipe import UserRolesRecipe from supertokens_python.recipe.userroles.recipe import UserRolesRecipe from supertokens_python.types import APIResponse @@ -65,10 +64,10 @@
Module
supertokens_python.recipe.dashboard.api.userroles async def get_permissions_for_role_api( - _api_interface: APIInterface, - _tenant_id: str, + _: APIInterface, + __: str, api_options: APIOptions, - user_context: Dict[str, Any], + ___: Dict[str, Any], ) -> Union[ OkPermissionsForRoleResponse, FeatureNotEnabledErrorResponse, @@ -100,7 +99,7 @@
Module
supertokens_python.recipe.dashboard.api.userroles
Functions
-async def get_permissions_for_role_api(_api_interface: APIInterface, _tenant_id: str, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[OkPermissionsForRoleResponse, FeatureNotEnabledErrorResponse, UnknownRoleErrorResponse] +async def get_permissions_for_role_api(_: APIInterface, __: str, api_options: APIOptions, ___: Dict[str, Any]) ‑> Union[OkPermissionsForRoleResponse, FeatureNotEnabledErrorResponse, UnknownRoleErrorResponse]
-
@@ -109,10 +108,10 @@
Functions
Expand source codeasync def get_permissions_for_role_api( - _api_interface: APIInterface, - _tenant_id: str, + _: APIInterface, + __: str, api_options: APIOptions, - user_context: Dict[str, Any], + ___: Dict[str, Any], ) -> Union[ OkPermissionsForRoleResponse, FeatureNotEnabledErrorResponse, diff --git a/html/supertokens_python/recipe/dashboard/api/userroles/permissions/index.html b/html/supertokens_python/recipe/dashboard/api/userroles/permissions/index.html index 81dc595e..398dce66 100644 --- a/html/supertokens_python/recipe/dashboard/api/userroles/permissions/index.html +++ b/html/supertokens_python/recipe/dashboard/api/userroles/permissions/index.html @@ -19,7 +19,7 @@
- Namespace
+supertokens_python.recipe.dashboard.api.userroles.permissions
Module
supertokens_python.recipe.dashboard.api.userroles.permissions
Module
supertokens_python.recipe.dashboard.api.userroles async def get_all_roles_api( - _: APIInterface, __: str, api_options: APIOptions, ___: Any + _: APIInterface, __: str, ___: APIOptions, ____: Any ) -> Union[OkResponse, FeatureNotEnabledErrorResponse]: try: UserRolesRecipe.get_instance() @@ -71,7 +71,7 @@
Module
supertokens_python.recipe.dashboard.api.userroles
Functions
-async def get_all_roles_api(_: APIInterface, __: str, api_options: APIOptions, ___: Any) ‑> Union[OkResponse, FeatureNotEnabledErrorResponse] +async def get_all_roles_api(_: APIInterface, __: str, ___: APIOptions, ____: Any) ‑> Union[OkResponse, FeatureNotEnabledErrorResponse]
-
@@ -80,7 +80,7 @@
Functions
Expand source codeasync def get_all_roles_api( - _: APIInterface, __: str, api_options: APIOptions, ___: Any + _: APIInterface, __: str, ___: APIOptions, ____: Any ) -> Union[OkResponse, FeatureNotEnabledErrorResponse]: try: UserRolesRecipe.get_instance() diff --git a/html/supertokens_python/recipe/dashboard/api/userroles/roles/index.html b/html/supertokens_python/recipe/dashboard/api/userroles/roles/index.html index 7835f686..35663a9f 100644 --- a/html/supertokens_python/recipe/dashboard/api/userroles/roles/index.html +++ b/html/supertokens_python/recipe/dashboard/api/userroles/roles/index.html @@ -19,7 +19,7 @@
- Namespace
+supertokens_python.recipe.dashboard.api.userroles.roles
Module
supertokens_python.recipe.dashboard.api.userroles.roles
Module
supertokens_python.recipe.totp.api.create_device< async def handle_create_device_api( - tenant_id: str, + _: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any], @@ -94,7 +94,7 @@
Module
supertokens_python.recipe.totp.api.create_device<
Functions
-async def handle_create_device_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None] +async def handle_create_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -103,7 +103,7 @@
Functions
Expand source codeasync def handle_create_device_api( - tenant_id: str, + _: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any], diff --git a/html/supertokens_python/recipe/totp/api/index.html b/html/supertokens_python/recipe/totp/api/index.html index 03a20cc2..92f04a5c 100644 --- a/html/supertokens_python/recipe/totp/api/index.html +++ b/html/supertokens_python/recipe/totp/api/index.html @@ -19,9 +19,40 @@
- Namespace
+supertokens_python.recipe.totp.api
Module
supertokens_python.recipe.totp.api
+ ++Expand source code +
+
+# Copyright (c) 2024, VRAI Labs and/or its affiliates. All rights reserved. +# +# This software is licensed under the Apache License, Version 2.0 (the +# "License") as published by the Apache Software Foundation. +# +# You may not use this file except in compliance with the License. You may +# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +from .create_device import handle_create_device_api +from .list_devices import handle_list_devices_api +from .remove_device import handle_remove_device_api +from .verify_device import handle_verify_device_api +from .verify_totp import handle_verify_totp_api + +__all__ = [ + "handle_create_device_api", + "handle_list_devices_api", + "handle_remove_device_api", + "handle_verify_device_api", + "handle_verify_totp_api", +]
Sub-modules
@@ -55,6 +86,227 @@Sub-modules
+ Functions
+-
+
+async def handle_create_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None] +
+-
+
+++
+Expand source code +
+
+async def handle_create_device_api( + _: str, + api_implementation: APIInterface, + api_options: APIOptions, + user_context: Dict[str, Any], +) -> Union[BaseResponse, None]: + if api_implementation.disable_create_device_post: + return None + + session = await get_session( + api_options.request, + override_global_claim_validators=lambda _, __, ___: [], + user_context=user_context, + ) + + assert session is not None + + body = await api_options.request.json() + if body is None: + raise_bad_input_exception("Please provide a JSON body") + + device_name = body.get("deviceName") + + if device_name is not None and not isinstance(device_name, str): + raise_bad_input_exception("deviceName must be a string") + + response = await api_implementation.create_device_post( + device_name, api_options, session, user_context + ) + + return send_200_response(response.to_json(), api_options.response)
+ +async def handle_list_devices_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None] +
+-
+
+++
+Expand source code +
+
+async def handle_list_devices_api( + _: str, + api_implementation: APIInterface, + api_options: APIOptions, + user_context: Dict[str, Any], +) -> Union[BaseResponse, None]: + if api_implementation.disable_list_devices_get: + return None + + session = await get_session( + api_options.request, + override_global_claim_validators=lambda _, __, ___: [], + session_required=True, + user_context=user_context, + ) + + assert session is not None + + response = await api_implementation.list_devices_get( + api_options, session, user_context + ) + + return send_200_response(response.to_json(), api_options.response)
+ +async def handle_remove_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None] +
+-
+
+++
+Expand source code +
+
+async def handle_remove_device_api( + _: str, + api_implementation: APIInterface, + api_options: APIOptions, + user_context: Dict[str, Any], +) -> Union[BaseResponse, None]: + if api_implementation.disable_remove_device_post: + return None + + session = await get_session( + api_options.request, + override_global_claim_validators=lambda _, __, ___: [], + session_required=True, + user_context=user_context, + ) + + assert session is not None + + body = await api_options.request.json() + if body is None: + raise_bad_input_exception("Please provide a JSON body") + device_name = body.get("deviceName") + + if device_name is None or not isinstance(device_name, str) or len(device_name) == 0: + raise Exception("deviceName is required and must be a non-empty string") + + response = await api_implementation.remove_device_post( + device_name=device_name, + options=api_options, + session=session, + user_context=user_context, + ) + + return send_200_response(response.to_json(), api_options.response)
+ +async def handle_verify_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None] +
+-
+
+++
+Expand source code +
+
+async def handle_verify_device_api( + _: str, + api_implementation: APIInterface, + api_options: APIOptions, + user_context: Dict[str, Any], +) -> Union[BaseResponse, None]: + if api_implementation.disable_verify_device_post: + return None + + session = await get_session( + api_options.request, + override_global_claim_validators=lambda _, __, ___: [], + session_required=True, + user_context=user_context, + ) + + assert session is not None + + body = await api_options.request.json() + if body is None: + raise_bad_input_exception("Please provide a JSON body") + + device_name = body.get("deviceName") + totp = body.get("totp") + + if device_name is None or not isinstance(device_name, str): + raise Exception("deviceName is required and must be a string") + + if totp is None or not isinstance(totp, str): + raise Exception("totp is required and must be a string") + + response = await api_implementation.verify_device_post( + device_name=device_name, + totp=totp, + options=api_options, + session=session, + user_context=user_context, + ) + + return send_200_response(response.to_json(), api_options.response)
+ +async def handle_verify_totp_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None] +
+-
+
+++
+Expand source code +
+
+async def handle_verify_totp_api( + _: str, + api_implementation: APIInterface, + api_options: APIOptions, + user_context: Dict[str, Any], +) -> Union[BaseResponse, None]: + if api_implementation.disable_verify_totp_post: + return None + + session = await get_session( + api_options.request, + override_global_claim_validators=lambda _, __, ___: [], + session_required=True, + user_context=user_context, + ) + + assert session is not None + + body = await api_options.request.json() + if body is None: + raise_bad_input_exception("Please provide a JSON body") + + totp = body.get("totp") + + if totp is None or not isinstance(totp, str): + raise Exception("totp is required and must be a string") + + response = await api_implementation.verify_totp_post( + totp=totp, + options=api_options, + session=session, + user_context=user_context, + ) + + return send_200_response(response.to_json(), api_options.response)
+
Index
+supertokens_python.recipe.totp.api.verify_totp
Functions
+ +Module
supertokens_python.recipe.totp.api.list_devices async def handle_list_devices_api( - tenant_id: str, + _: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any], @@ -84,7 +84,7 @@
Module
supertokens_python.recipe.totp.api.list_devices
Functions
-async def handle_list_devices_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None] +async def handle_list_devices_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -93,7 +93,7 @@
Functions
Expand source codeasync def handle_list_devices_api( - tenant_id: str, + _: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any], diff --git a/html/supertokens_python/recipe/totp/api/remove_device.html b/html/supertokens_python/recipe/totp/api/remove_device.html index 728a7351..4ec68002 100644 --- a/html/supertokens_python/recipe/totp/api/remove_device.html +++ b/html/supertokens_python/recipe/totp/api/remove_device.html @@ -53,7 +53,7 @@
Module
supertokens_python.recipe.totp.api.remove_device< async def handle_remove_device_api( - tenant_id: str, + _: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any], @@ -96,7 +96,7 @@
Module
supertokens_python.recipe.totp.api.remove_device<
Functions
-async def handle_remove_device_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None] +async def handle_remove_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -105,7 +105,7 @@
Functions
Expand source codeasync def handle_remove_device_api( - tenant_id: str, + _: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any], diff --git a/html/supertokens_python/recipe/totp/api/verify_device.html b/html/supertokens_python/recipe/totp/api/verify_device.html index 1392a5ec..290b9335 100644 --- a/html/supertokens_python/recipe/totp/api/verify_device.html +++ b/html/supertokens_python/recipe/totp/api/verify_device.html @@ -53,7 +53,7 @@
Module
supertokens_python.recipe.totp.api.verify_device< async def handle_verify_device_api( - tenant_id: str, + _: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any], @@ -102,7 +102,7 @@
Module
supertokens_python.recipe.totp.api.verify_device<
Functions
-async def handle_verify_device_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None] +async def handle_verify_device_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -111,7 +111,7 @@
Functions
Expand source codeasync def handle_verify_device_api( - tenant_id: str, + _: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any], diff --git a/html/supertokens_python/recipe/totp/api/verify_totp.html b/html/supertokens_python/recipe/totp/api/verify_totp.html index 3f240d97..9feb92ab 100644 --- a/html/supertokens_python/recipe/totp/api/verify_totp.html +++ b/html/supertokens_python/recipe/totp/api/verify_totp.html @@ -53,7 +53,7 @@
Module
supertokens_python.recipe.totp.api.verify_totpModule
supertokens_python.recipe.totp.api.verify_totpFunctions
-async def handle_verify_totp_api(tenant_id: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None] +async def handle_verify_totp_api(_: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any]) ‑> Union[BaseResponse, None]
-
@@ -106,7 +106,7 @@
Functions
Expand source codeasync def handle_verify_totp_api( - tenant_id: str, + _: str, api_implementation: APIInterface, api_options: APIOptions, user_context: Dict[str, Any],