diff --git a/html/supertokens_python/constants.html b/html/supertokens_python/constants.html index d7ac43004..287117a17 100644 --- a/html/supertokens_python/constants.html +++ b/html/supertokens_python/constants.html @@ -40,7 +40,7 @@
supertokens_python.constants
supertokens_python.recipe.userroles.syncio
def remove_user_role(
- user_id: str, role: str, user_context: Dict[str, Any]
+ user_id: str, role: str, user_context: Union[Dict[str, Any], None] = None
) -> Union[RemoveUserRoleOkResult, UnknownRoleError]:
from supertokens_python.recipe.userroles.asyncio import remove_user_role
@@ -75,7 +75,7 @@ supertokens_python.recipe.userroles.syncio
def get_roles_for_user(
- user_id: str, user_context: Dict[str, Any]
+ user_id: str, user_context: Union[Dict[str, Any], None] = None
) -> GetRolesForUserOkResult:
from supertokens_python.recipe.userroles.asyncio import get_roles_for_user
@@ -83,7 +83,7 @@ supertokens_python.recipe.userroles.syncio
def get_users_that_have_role(
- role: str, user_context: Dict[str, Any]
+ role: str, user_context: Union[Dict[str, Any], None] = None
) -> Union[GetUsersThatHaveRoleOkResult, UnknownRoleError]:
from supertokens_python.recipe.userroles.asyncio import get_users_that_have_role
@@ -91,7 +91,7 @@ supertokens_python.recipe.userroles.syncio
def create_new_role_or_add_permissions(
- role: str, permissions: List[str], user_context: Dict[str, Any]
+ role: str, permissions: List[str], user_context: Union[Dict[str, Any], None] = None
) -> CreateNewRoleOrAddPermissionsOkResult:
from supertokens_python.recipe.userroles.asyncio import (
create_new_role_or_add_permissions,
@@ -101,7 +101,7 @@ supertokens_python.recipe.userroles.syncio
def get_permissions_for_role(
- role: str, user_context: Dict[str, Any]
+ role: str, user_context: Union[Dict[str, Any], None] = None
) -> Union[GetPermissionsForRoleOkResult, UnknownRoleError]:
from supertokens_python.recipe.userroles.asyncio import get_permissions_for_role
@@ -109,7 +109,7 @@ supertokens_python.recipe.userroles.syncio
def remove_permissions_from_role(
- role: str, permissions: List[str], user_context: Dict[str, Any]
+ role: str, permissions: List[str], user_context: Union[Dict[str, Any], None] = None
) -> Union[RemovePermissionsFromRoleOkResult, UnknownRoleError]:
from supertokens_python.recipe.userroles.asyncio import remove_permissions_from_role
@@ -117,7 +117,7 @@ supertokens_python.recipe.userroles.syncio
def get_roles_that_have_permission(
- permission: str, user_context: Dict[str, Any]
+ permission: str, user_context: Union[Dict[str, Any], None] = None
) -> GetRolesThatHavePermissionOkResult:
from supertokens_python.recipe.userroles.asyncio import (
get_roles_that_have_permission,
@@ -126,13 +126,17 @@ supertokens_python.recipe.userroles.syncio
return sync(get_roles_that_have_permission(permission, user_context))
-def delete_role(role: str, user_context: Dict[str, Any]) -> DeleteRoleOkResult:
+def delete_role(
+ role: str, user_context: Union[Dict[str, Any], None] = None
+) -> DeleteRoleOkResult:
from supertokens_python.recipe.userroles.asyncio import delete_role
return sync(delete_role(role, user_context))
-def get_all_roles(user_context: Dict[str, Any]) -> GetAllRolesOkResult:
+def get_all_roles(
+ user_context: Union[Dict[str, Any], None] = None
+) -> GetAllRolesOkResult:
from supertokens_python.recipe.userroles.asyncio import get_all_roles
return sync(get_all_roles(user_context))
@@ -163,7 +167,7 @@
-def create_new_role_or_add_permissions(role: str, permissions: List[str], user_context: Dict[str, Any]) ‑> CreateNewRoleOrAddPermissionsOkResult
+def create_new_role_or_add_permissions(role: str, permissions: List[str], user_context: Optional[Dict[str, Any]] = None) ‑> CreateNewRoleOrAddPermissionsOkResult
def create_new_role_or_add_permissions(
- role: str, permissions: List[str], user_context: Dict[str, Any]
+ role: str, permissions: List[str], user_context: Union[Dict[str, Any], None] = None
) -> CreateNewRoleOrAddPermissionsOkResult:
from supertokens_python.recipe.userroles.asyncio import (
create_new_role_or_add_permissions,
@@ -182,7 +186,7 @@ Functions
-def delete_role(role: str, user_context: Dict[str, Any]) ‑> DeleteRoleOkResult
+def delete_role(role: str, user_context: Optional[Dict[str, Any]] = None) ‑> DeleteRoleOkResult
def delete_role(role: str, user_context: Dict[str, Any]) -> DeleteRoleOkResult:
+def delete_role(
+ role: str, user_context: Union[Dict[str, Any], None] = None
+) -> DeleteRoleOkResult:
from supertokens_python.recipe.userroles.asyncio import delete_role
return sync(delete_role(role, user_context))
-def get_all_roles(user_context: Dict[str, Any]) ‑> GetAllRolesOkResult
+def get_all_roles(user_context: Optional[Dict[str, Any]] = None) ‑> GetAllRolesOkResult
def get_all_roles(user_context: Dict[str, Any]) -> GetAllRolesOkResult:
+def get_all_roles(
+ user_context: Union[Dict[str, Any], None] = None
+) -> GetAllRolesOkResult:
from supertokens_python.recipe.userroles.asyncio import get_all_roles
return sync(get_all_roles(user_context))
-def get_permissions_for_role(role: str, user_context: Dict[str, Any]) ‑> Union[GetPermissionsForRoleOkResult, UnknownRoleError]
+def get_permissions_for_role(role: str, user_context: Optional[Dict[str, Any]] = None) ‑> Union[GetPermissionsForRoleOkResult, UnknownRoleError]
def get_permissions_for_role(
- role: str, user_context: Dict[str, Any]
+ role: str, user_context: Union[Dict[str, Any], None] = None
) -> Union[GetPermissionsForRoleOkResult, UnknownRoleError]:
from supertokens_python.recipe.userroles.asyncio import get_permissions_for_role
@@ -229,7 +237,7 @@ Functions
-def get_roles_for_user(user_id: str, user_context: Dict[str, Any]) ‑> GetRolesForUserOkResult
+def get_roles_for_user(user_id: str, user_context: Optional[Dict[str, Any]] = None) ‑> GetRolesForUserOkResult
def get_roles_for_user(
- user_id: str, user_context: Dict[str, Any]
+ user_id: str, user_context: Union[Dict[str, Any], None] = None
) -> GetRolesForUserOkResult:
from supertokens_python.recipe.userroles.asyncio import get_roles_for_user
@@ -246,7 +254,7 @@ Functions
-def get_roles_that_have_permission(permission: str, user_context: Dict[str, Any]) ‑> GetRolesThatHavePermissionOkResult
+def get_roles_that_have_permission(permission: str, user_context: Optional[Dict[str, Any]] = None) ‑> GetRolesThatHavePermissionOkResult
def get_roles_that_have_permission(
- permission: str, user_context: Dict[str, Any]
+ permission: str, user_context: Union[Dict[str, Any], None] = None
) -> GetRolesThatHavePermissionOkResult:
from supertokens_python.recipe.userroles.asyncio import (
get_roles_that_have_permission,
@@ -265,7 +273,7 @@ Functions
-def get_users_that_have_role(role: str, user_context: Dict[str, Any]) ‑> Union[GetUsersThatHaveRoleOkResult, UnknownRoleError]
+def get_users_that_have_role(role: str, user_context: Optional[Dict[str, Any]] = None) ‑> Union[GetUsersThatHaveRoleOkResult, UnknownRoleError]
def get_users_that_have_role(
- role: str, user_context: Dict[str, Any]
+ role: str, user_context: Union[Dict[str, Any], None] = None
) -> Union[GetUsersThatHaveRoleOkResult, UnknownRoleError]:
from supertokens_python.recipe.userroles.asyncio import get_users_that_have_role
@@ -282,7 +290,7 @@ Functions
-def remove_permissions_from_role(role: str, permissions: List[str], user_context: Dict[str, Any]) ‑> Union[RemovePermissionsFromRoleOkResult, UnknownRoleError]
+def remove_permissions_from_role(role: str, permissions: List[str], user_context: Optional[Dict[str, Any]] = None) ‑> Union[RemovePermissionsFromRoleOkResult, UnknownRoleError]
def remove_permissions_from_role(
- role: str, permissions: List[str], user_context: Dict[str, Any]
+ role: str, permissions: List[str], user_context: Union[Dict[str, Any], None] = None
) -> Union[RemovePermissionsFromRoleOkResult, UnknownRoleError]:
from supertokens_python.recipe.userroles.asyncio import remove_permissions_from_role
@@ -299,7 +307,7 @@ Functions
-def remove_user_role(user_id: str, role: str, user_context: Dict[str, Any]) ‑> Union[RemoveUserRoleOkResult, UnknownRoleError]
+def remove_user_role(user_id: str, role: str, user_context: Optional[Dict[str, Any]] = None) ‑> Union[RemoveUserRoleOkResult, UnknownRoleError]
def remove_user_role(
- user_id: str, role: str, user_context: Dict[str, Any]
+ user_id: str, role: str, user_context: Union[Dict[str, Any], None] = None
) -> Union[RemoveUserRoleOkResult, UnknownRoleError]:
from supertokens_python.recipe.userroles.asyncio import remove_user_role