Expand source code
from typing import Any, Dict, List, Union
from supertokens_python.recipe.userroles.interfaces import (
AddRoleToUserOkResult,
CreateNewRoleOrAddPermissionsOkResult,
DeleteRoleOkResult,
GetAllRolesOkResult,
GetPermissionsForRoleOkResult,
GetRolesForUserOkResult,
GetRolesThatHavePermissionOkResult,
GetUsersThatHaveRoleOkResult,
RemovePermissionsFromRoleOkResult,
RemoveUserRoleOkResult,
UnknownRoleError,
)
from supertokens_python.recipe.userroles.recipe import UserRolesRecipe
async def add_role_to_user(
tenant_id: str,
user_id: str,
role: str,
user_context: Union[Dict[str, Any], None] = None,
) -> Union[AddRoleToUserOkResult, UnknownRoleError]:
if user_context is None:
user_context = {}
return await UserRolesRecipe.get_instance().recipe_implementation.add_role_to_user(
user_id, role, tenant_id, user_context
)
async def remove_user_role(
tenant_id: str,
user_id: str,
role: str,
user_context: Union[Dict[str, Any], None] = None,
) -> Union[RemoveUserRoleOkResult, UnknownRoleError]:
if user_context is None:
user_context = {}
return await UserRolesRecipe.get_instance().recipe_implementation.remove_user_role(
user_id, role, tenant_id, user_context
)
async def get_roles_for_user(
tenant_id: str, user_id: str, user_context: Union[Dict[str, Any], None] = None
) -> GetRolesForUserOkResult:
if user_context is None:
user_context = {}
return (
await UserRolesRecipe.get_instance().recipe_implementation.get_roles_for_user(
user_id, tenant_id, user_context
)
)
async def get_users_that_have_role(
tenant_id: str, role: str, user_context: Union[Dict[str, Any], None] = None
) -> Union[GetUsersThatHaveRoleOkResult, UnknownRoleError]:
if user_context is None:
user_context = {}
return await UserRolesRecipe.get_instance().recipe_implementation.get_users_that_have_role(
role, tenant_id, user_context
)
async def create_new_role_or_add_permissions(
role: str, permissions: List[str], user_context: Union[Dict[str, Any], None] = None
) -> CreateNewRoleOrAddPermissionsOkResult:
if user_context is None:
user_context = {}
return await UserRolesRecipe.get_instance().recipe_implementation.create_new_role_or_add_permissions(
role, permissions, user_context
)
async def get_permissions_for_role(
role: str, user_context: Union[Dict[str, Any], None] = None
) -> Union[GetPermissionsForRoleOkResult, UnknownRoleError]:
if user_context is None:
user_context = {}
return await UserRolesRecipe.get_instance().recipe_implementation.get_permissions_for_role(
role, user_context
)
async def remove_permissions_from_role(
role: str, permissions: List[str], user_context: Union[Dict[str, Any], None] = None
) -> Union[RemovePermissionsFromRoleOkResult, UnknownRoleError]:
if user_context is None:
user_context = {}
return await UserRolesRecipe.get_instance().recipe_implementation.remove_permissions_from_role(
role, permissions, user_context
)
async def get_roles_that_have_permission(
permission: str, user_context: Union[Dict[str, Any], None] = None
) -> GetRolesThatHavePermissionOkResult:
if user_context is None:
user_context = {}
return await UserRolesRecipe.get_instance().recipe_implementation.get_roles_that_have_permission(
permission, user_context
)
async def delete_role(
role: str, user_context: Union[Dict[str, Any], None] = None
) -> DeleteRoleOkResult:
if user_context is None:
user_context = {}
return await UserRolesRecipe.get_instance().recipe_implementation.delete_role(
role, user_context
)
async def get_all_roles(
user_context: Union[Dict[str, Any], None] = None
) -> GetAllRolesOkResult:
if user_context is None:
user_context = {}
return await UserRolesRecipe.get_instance().recipe_implementation.get_all_roles(
user_context
)