Module supertokens_python.recipe.userroles

Expand source code
# Copyright (c) 2021, 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 __future__ import annotations

from typing import TYPE_CHECKING, Callable, Union, Optional

from . import utils
from .recipe import UserRolesRecipe
from . import recipe

PermissionClaim = recipe.PermissionClaim
UserRoleClaim = recipe.UserRoleClaim

if TYPE_CHECKING:
    from supertokens_python.supertokens import AppInfo

    from ...recipe_module import RecipeModule


def init(
    skip_adding_roles_to_access_token: Optional[bool] = None,
    skip_adding_permissions_to_access_token: Optional[bool] = None,
    override: Union[utils.InputOverrideConfig, None] = None,
) -> Callable[[AppInfo], RecipeModule]:
    return UserRolesRecipe.init(
        skip_adding_roles_to_access_token,
        skip_adding_permissions_to_access_token,
        override,
    )

Sub-modules

supertokens_python.recipe.userroles.asyncio
supertokens_python.recipe.userroles.exceptions
supertokens_python.recipe.userroles.interfaces
supertokens_python.recipe.userroles.recipe
supertokens_python.recipe.userroles.recipe_implementation
supertokens_python.recipe.userroles.syncio
supertokens_python.recipe.userroles.utils

Functions

def init(skip_adding_roles_to_access_token: Optional[bool] = None, skip_adding_permissions_to_access_token: Optional[bool] = None, override: Union[InputOverrideConfig, None] = None) ‑> Callable[[AppInfo], RecipeModule]
Expand source code
def init(
    skip_adding_roles_to_access_token: Optional[bool] = None,
    skip_adding_permissions_to_access_token: Optional[bool] = None,
    override: Union[utils.InputOverrideConfig, None] = None,
) -> Callable[[AppInfo], RecipeModule]:
    return UserRolesRecipe.init(
        skip_adding_roles_to_access_token,
        skip_adding_permissions_to_access_token,
        override,
    )