Module supertokens_python.recipe.dashboard.interfaces

Classes

class APIInterface

Expand source code

class APIInterface:
    def __init__(self):
        # undefined should be allowed
        self.dashboard_get: Optional[
            Callable[[APIOptions, Dict[str, Any]], Awaitable[str]]
        ] = None

Subclasses

• APIImplementation

class APIOptions (request: BaseRequest, response: BaseResponse, recipe_id: str, config: DashboardConfig, recipe_implementation: RecipeInterface, app_info: AppInfo)

Expand source code

class APIOptions:
    def __init__(
        self,
        request: BaseRequest,
        response: BaseResponse,
        recipe_id: str,
        config: DashboardConfig,
        recipe_implementation: RecipeInterface,
        app_info: AppInfo,
    ):
        self.request: BaseRequest = request
        self.response: BaseResponse = response
        self.recipe_id: str = recipe_id
        self.config: DashboardConfig = config
        self.recipe_implementation: RecipeInterface = recipe_implementation
        self.app_info = app_info

class AnalyticsResponse

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

Expand source code

class AnalyticsResponse(APIResponse):
    status: str = "OK"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class CoreConfigFieldInfo (key: str, value_type: "Literal[('string', 'boolean', 'number')]", value: Union[str, int, float, bool, None], description: str, is_different_across_tenants: bool, possible_values: Union[List[str], None] = None, is_nullable: bool = False, default_value: Union[str, int, float, bool, None] = None, is_plugin_property: bool = False, is_plugin_property_editable: bool = False)

Expand source code

class CoreConfigFieldInfo:
    def __init__(
        self,
        key: str,
        value_type: Literal["string", "boolean", "number"],
        value: Union[str, int, float, bool, None],
        description: str,
        is_different_across_tenants: bool,
        possible_values: Union[List[str], None] = None,
        is_nullable: bool = False,
        default_value: Union[str, int, float, bool, None] = None,
        is_plugin_property: bool = False,
        is_plugin_property_editable: bool = False,
    ):
        self.key = key
        self.value_type = value_type
        self.value = value
        self.description = description
        self.is_different_across_tenants = is_different_across_tenants
        self.possible_values = possible_values
        self.is_nullable = is_nullable
        self.default_value = default_value
        self.is_plugin_property = is_plugin_property
        self.is_plugin_property_editable = is_plugin_property_editable

    def to_json(self) -> Dict[str, Any]:
        result: Dict[str, Any] = {
            "key": self.key,
            "valueType": self.value_type,
            "value": self.value,
            "description": self.description,
            "isDifferentAcrossTenants": self.is_different_across_tenants,
            "isNullable": self.is_nullable,
            "defaultValue": self.default_value,
            "isPluginProperty": self.is_plugin_property,
            "isPluginPropertyEditable": self.is_plugin_property_editable,
        }
        if self.possible_values is not None:
            result["possibleValues"] = self.possible_values
        return result

    @staticmethod
    def from_json(json: Dict[str, Any]) -> CoreConfigFieldInfo:
        return CoreConfigFieldInfo(
            key=json["key"],
            value_type=json["valueType"],
            value=json["value"],
            description=json["description"],
            is_different_across_tenants=json["isDifferentAcrossTenants"],
            possible_values=json["possibleValues"],
            is_nullable=json["isNullable"],
            default_value=json["defaultValue"],
            is_plugin_property=json["isPluginProperty"],
            is_plugin_property_editable=json["isPluginPropertyEditable"],
        )

Static methods

def from_json(json: Dict[str, Any]) ‑> CoreConfigFieldInfo

Methods

def to_json(self) ‑> Dict[str, Any]

class DashboardListTenantItem (tenant_config: TenantConfig)

Expand source code

class DashboardListTenantItem:
    def __init__(self, tenant_config: TenantConfig):
        self.tenant_config = tenant_config

    def to_json(self) -> Dict[str, Any]:
        return {
            "tenantId": self.tenant_config.tenant_id,
        }

Methods

def to_json(self) ‑> Dict[str, Any]

class DashboardListTenantsGetResponse (tenants: List[DashboardListTenantItem])

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

Expand source code

class DashboardListTenantsGetResponse(APIResponse):
    status: str = "OK"

    def __init__(self, tenants: List[DashboardListTenantItem]) -> None:
        self.tenants = tenants

    def to_json(self) -> Dict[str, Any]:
        return {
            "status": self.status,
            "tenants": [t.to_json() for t in self.tenants],
        }

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class DashboardUsersGetResponse (users: List[UserWithMetadata], next_pagination_token: Optional[str])

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

Expand source code

class DashboardUsersGetResponse(APIResponse):
    status: str = "OK"

    def __init__(
        self,
        users: List[UserWithMetadata],
        next_pagination_token: Optional[str],
    ):
        self.users = users
        self.next_pagination_token = next_pagination_token

    def to_json(self) -> Dict[str, Any]:
        return {
            "status": self.status,
            "users": [u.to_json() for u in self.users],
            "nextPaginationToken": self.next_pagination_token,
        }

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class FeatureNotEnabledError

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

Expand source code

class FeatureNotEnabledError(APIResponse):
    status: str = "FEATURE_NOT_ENABLED_ERROR"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class RecipeInterface

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

Expand source code

class RecipeInterface(ABC):
    def __init__(self):
        pass

    @abstractmethod
    async def get_dashboard_bundle_location(self, user_context: Dict[str, Any]) -> str:
        pass

    @abstractmethod
    async def should_allow_access(
        self,
        request: BaseRequest,
        config: DashboardConfig,
        user_context: Dict[str, Any],
    ) -> bool:
        pass

Ancestors

• abc.ABC

Subclasses

• RecipeImplementation

Methods

async def get_dashboard_bundle_location(self, user_context: Dict[str, Any]) ‑> str

async def should_allow_access(self, request: BaseRequest, config: DashboardConfig, user_context: Dict[str, Any])

class SearchTagsOK (tags: List[str])

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

Expand source code

class SearchTagsOK(APIResponse):
    status: str = "OK"
    tags: List[str]

    def __init__(self, tags: List[str]) -> None:
        self.tags = tags

    def to_json(self):
        return {"status": self.status, "tags": self.tags}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

var tags : List[str]

Methods

def to_json(self)

class SessionInfo (info: SessionInformationResult)

Expand source code

class SessionInfo:
    def __init__(self, info: SessionInformationResult) -> None:
        self.session_handle = info.session_handle
        self.user_id = info.user_id
        self.session_data_in_database = info.session_data_in_database
        self.expiry = info.expiry
        self.access_token_payload = info.custom_claims_in_access_token_payload
        self.time_created = info.time_created
        self.tenant_id = info.tenant_id

class SignOutOK

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

Expand source code

class SignOutOK(APIResponse):
    status: str = "OK"

    def to_json(self):
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self)

class UserCountGetAPIResponse (count: int)

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

Expand source code

class UserCountGetAPIResponse(APIResponse):
    status: str = "OK"

    def __init__(self, count: int):
        self.count = count

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status, "count": self.count}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserDeleteAPIResponse

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

Expand source code

class UserDeleteAPIResponse(APIResponse):
    status: str = "OK"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserEmailVerifyGetAPIResponse (is_verified: bool)

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

Expand source code

class UserEmailVerifyGetAPIResponse(APIResponse):
    status: str = "OK"

    def __init__(self, is_verified: bool):
        self.is_verified = is_verified

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status, "isVerified": self.is_verified}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserEmailVerifyPutAPIResponse

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

Expand source code

class UserEmailVerifyPutAPIResponse(APIResponse):
    status: str = "OK"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserEmailVerifyTokenPostAPIEmailAlreadyVerifiedErrorResponse

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

Expand source code

class UserEmailVerifyTokenPostAPIEmailAlreadyVerifiedErrorResponse(APIResponse):
    status: str = "EMAIL_ALREADY_VERIFIED_ERROR"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserEmailVerifyTokenPostAPIOkResponse

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

Expand source code

class UserEmailVerifyTokenPostAPIOkResponse(APIResponse):
    status: str = "OK"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserGetAPINoUserFoundError

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

Expand source code

class UserGetAPINoUserFoundError(APIResponse):
    status: str = "NO_USER_FOUND_ERROR"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserGetAPIOkResponse (user: UserWithMetadata)

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

Expand source code

class UserGetAPIOkResponse(APIResponse):
    status: str = "OK"

    def __init__(self, user: UserWithMetadata):
        self.user = user

    def to_json(self) -> Dict[str, Any]:
        return {
            "status": self.status,
            "user": self.user.to_json(),
        }

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserMetadataGetAPIOkResponse (data: Dict[str, Any])

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

Expand source code

class UserMetadataGetAPIOkResponse(APIResponse):
    status: str = "OK"

    def __init__(self, data: Dict[str, Any]) -> None:
        self.data = data

    def to_json(self) -> Dict[str, Any]:
        return {"status": "OK", "data": self.data}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserMetadataPutAPIResponse

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

Expand source code

class UserMetadataPutAPIResponse(APIResponse):
    status: str = "OK"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserPasswordPutAPIInvalidPasswordErrorResponse (error: str)

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

Expand source code

class UserPasswordPutAPIInvalidPasswordErrorResponse(APIResponse):
    status: str = "INVALID_PASSWORD_ERROR"

    def __init__(self, error: str) -> None:
        self.error = error

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status, "error": self.error}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserPasswordPutAPIResponse

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

Expand source code

class UserPasswordPutAPIResponse(APIResponse):
    status: str = "OK"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserPutAPIEmailAlreadyExistsErrorResponse

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

Expand source code

class UserPutAPIEmailAlreadyExistsErrorResponse(APIResponse):
    status: str = "EMAIL_ALREADY_EXISTS_ERROR"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserPutAPIInvalidEmailErrorResponse (error: str)

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

Expand source code

class UserPutAPIInvalidEmailErrorResponse(APIResponse):
    status: str = "INVALID_EMAIL_ERROR"

    def __init__(self, error: str) -> None:
        self.error = error

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status, "error": self.error}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserPutAPIInvalidPhoneErrorResponse (error: str)

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

Expand source code

class UserPutAPIInvalidPhoneErrorResponse(APIResponse):
    status: str = "INVALID_PHONE_ERROR"

    def __init__(self, error: str) -> None:
        self.error = error

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status, "error": self.error}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserPutAPIOkResponse

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

Expand source code

class UserPutAPIOkResponse(APIResponse):
    status: str = "OK"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserPutPhoneAlreadyExistsAPIResponse

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

Expand source code

class UserPutPhoneAlreadyExistsAPIResponse(APIResponse):
    status: str = "PHONE_ALREADY_EXISTS_ERROR"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserSessionsGetAPIResponse (sessions: List[SessionInfo])

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

Expand source code

class UserSessionsGetAPIResponse(APIResponse):
    status: str = "OK"

    def __init__(self, sessions: List[SessionInfo]):
        self.sessions = [
            {
                "accessTokenPayload": s.access_token_payload,
                "expiry": s.expiry,
                "sessionDataInDatabase": s.session_data_in_database,
                "timeCreated": s.time_created,
                "userId": s.user_id,
                "sessionHandle": s.session_handle,
            }
            for s in sessions
        ]

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status, "sessions": self.sessions}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]

class UserSessionsPostAPIResponse

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

Expand source code

class UserSessionsPostAPIResponse(APIResponse):
    status: str = "OK"

    def to_json(self) -> Dict[str, Any]:
        return {"status": self.status}

Ancestors

• APIResponse
• abc.ABC

Class variables

var status : str

Methods

def to_json(self) ‑> Dict[str, Any]