Module supertokens_python.recipe.dashboard.api.userroles.remove_user_role
Expand source code
from typing import Any, Union
from typing_extensions import Literal
from supertokens_python.exceptions import raise_bad_input_exception
from supertokens_python.recipe.dashboard.interfaces import APIInterface, APIOptions
from supertokens_python.recipe.userroles.asyncio import remove_user_role
from supertokens_python.recipe.userroles.interfaces import RemoveUserRoleOkResult
from supertokens_python.recipe.userroles.recipe import UserRolesRecipe
from supertokens_python.types import APIResponse
class OkResponse(APIResponse):
def __init__(self, did_user_have_role: bool):
self.status: Literal["OK"] = "OK"
self.did_user_have_role = did_user_have_role
def to_json(self):
return {
"status": self.status,
"didUserHaveRole": self.did_user_have_role,
}
class FeatureNotEnabledErrorResponse(APIResponse):
def __init__(self):
self.status: Literal["FEATURE_NOT_ENABLED_ERROR"] = "FEATURE_NOT_ENABLED_ERROR"
def to_json(self):
return {"status": self.status}
class UnknownRoleErrorResponse(APIResponse):
def __init__(self):
self.status: Literal["UNKNOWN_ROLE_ERROR"] = "UNKNOWN_ROLE_ERROR"
def to_json(self):
return {"status": self.status}
async def remove_user_role_api(
_: APIInterface, tenant_id: str, api_options: APIOptions, __: Any
) -> Union[OkResponse, FeatureNotEnabledErrorResponse, UnknownRoleErrorResponse]:
try:
UserRolesRecipe.get_instance()
except Exception:
return FeatureNotEnabledErrorResponse()
user_id = api_options.request.get_query_param("userId")
role = api_options.request.get_query_param("role")
if role is None:
raise_bad_input_exception(
"Required parameter 'role' is missing or has an invalid type"
)
if user_id is None:
raise_bad_input_exception(
"Required parameter 'userId' is missing or has an invalid type"
)
response = await remove_user_role(tenant_id, user_id, role)
if isinstance(response, RemoveUserRoleOkResult):
return OkResponse(did_user_have_role=response.did_user_have_role)
else:
return UnknownRoleErrorResponse()
Functions
async def remove_user_role_api(_: APIInterface, tenant_id: str, api_options: APIOptions, __: Any) ‑> Union[OkResponse, FeatureNotEnabledErrorResponse, UnknownRoleErrorResponse]
Classes
class FeatureNotEnabledErrorResponse
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class FeatureNotEnabledErrorResponse(APIResponse): def __init__(self): self.status: Literal["FEATURE_NOT_ENABLED_ERROR"] = "FEATURE_NOT_ENABLED_ERROR" def to_json(self): return {"status": self.status}
Ancestors
- APIResponse
- abc.ABC
Methods
def to_json(self)
class OkResponse (did_user_have_role: bool)
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class OkResponse(APIResponse): def __init__(self, did_user_have_role: bool): self.status: Literal["OK"] = "OK" self.did_user_have_role = did_user_have_role def to_json(self): return { "status": self.status, "didUserHaveRole": self.did_user_have_role, }
Ancestors
- APIResponse
- abc.ABC
Methods
def to_json(self)
class UnknownRoleErrorResponse
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class UnknownRoleErrorResponse(APIResponse): def __init__(self): self.status: Literal["UNKNOWN_ROLE_ERROR"] = "UNKNOWN_ROLE_ERROR" def to_json(self): return {"status": self.status}
Ancestors
- APIResponse
- abc.ABC
Methods
def to_json(self)