userroles

Documentation

Index

• Constants
• func AddRoleToUser(userID string, role string, userContext supertokens.UserContext) (userrolesmodels.AddRoleToUserResponse, error)
• func AfterEach()
• func BeforeEach()
• func CreateNewRoleOrAddPermissions(role string, permissions []string, userContext supertokens.UserContext) (userrolesmodels.CreateNewRoleOrAddPermissionsResponse, error)
• func DeleteRole(role string, userContext supertokens.UserContext) (userrolesmodels.DeleteRoleResponse, error)
• func GetAllRoles(userContext supertokens.UserContext) (userrolesmodels.GetAllRolesResponse, error)
• func GetPermissionsForRole(role string, userContext supertokens.UserContext) (userrolesmodels.GetPermissionsForRoleResponse, error)
• func GetRolesForUser(userID string, userContext supertokens.UserContext) (userrolesmodels.GetRolesForUserResponse, error)
• func GetRolesThatHavePermission(permission string, userContext supertokens.UserContext) (userrolesmodels.GetRolesThatHavePermissionResponse, error)
• func GetUsersThatHaveRole(role string, userContext supertokens.UserContext) (userrolesmodels.GetUsersThatHaveRoleResponse, error)
• func Init(config *userrolesmodels.TypeInput) supertokens.Recipe
• func NewPermissionClaim() (*claims.TypeSessionClaim, claims.PrimitiveArrayClaimValidators)
• func NewUserRoleClaim() (*claims.TypeSessionClaim, claims.PrimitiveArrayClaimValidators)
• func RemovePermissionsFromRole(role string, permissions []string, userContext supertokens.UserContext) (userrolesmodels.RemovePermissionsFromRoleResponse, error)
• func RemoveUserRole(userID string, role string, userContext supertokens.UserContext) (userrolesmodels.RemoveUserRoleResponse, error)
• func ResetForTest()
• type Recipe
  • func MakeRecipe(recipeId string, appInfo supertokens.NormalisedAppinfo, ...) (Recipe, error)

Constants

const RECIPE_ID = "userroles"

Functions

func AddRoleToUser

func AddRoleToUser(userID string, role string, userContext supertokens.UserContext) (userrolesmodels.AddRoleToUserResponse, error)

func AfterEach

func AfterEach()

func BeforeEach

func BeforeEach()

func CreateNewRoleOrAddPermissions

func CreateNewRoleOrAddPermissions(role string, permissions []string, userContext supertokens.UserContext) (userrolesmodels.CreateNewRoleOrAddPermissionsResponse, error)

func DeleteRole

func DeleteRole(role string, userContext supertokens.UserContext) (userrolesmodels.DeleteRoleResponse, error)

func GetAllRoles

func GetAllRoles(userContext supertokens.UserContext) (userrolesmodels.GetAllRolesResponse, error)

func GetPermissionsForRole

func GetPermissionsForRole(role string, userContext supertokens.UserContext) (userrolesmodels.GetPermissionsForRoleResponse, error)

func GetRolesForUser

func GetRolesForUser(userID string, userContext supertokens.UserContext) (userrolesmodels.GetRolesForUserResponse, error)

func GetRolesThatHavePermission

func GetRolesThatHavePermission(permission string, userContext supertokens.UserContext) (userrolesmodels.GetRolesThatHavePermissionResponse, error)

func GetUsersThatHaveRole

func GetUsersThatHaveRole(role string, userContext supertokens.UserContext) (userrolesmodels.GetUsersThatHaveRoleResponse, error)

func Init

func Init(config *userrolesmodels.TypeInput) supertokens.Recipe

func NewPermissionClaim

func NewPermissionClaim() (*claims.TypeSessionClaim, claims.PrimitiveArrayClaimValidators)

func NewUserRoleClaim

func NewUserRoleClaim() (*claims.TypeSessionClaim, claims.PrimitiveArrayClaimValidators)

func RemovePermissionsFromRole

func RemovePermissionsFromRole(role string, permissions []string, userContext supertokens.UserContext) (userrolesmodels.RemovePermissionsFromRoleResponse, error)

func RemoveUserRole

func RemoveUserRole(userID string, role string, userContext supertokens.UserContext) (userrolesmodels.RemoveUserRoleResponse, error)

func ResetForTest

func ResetForTest()

Types

type Recipe

type Recipe struct {
	RecipeModule supertokens.RecipeModule
	Config       userrolesmodels.TypeNormalisedInput
	RecipeImpl   userrolesmodels.RecipeInterface
}

func MakeRecipe

func MakeRecipe(recipeId string, appInfo supertokens.NormalisedAppinfo, config *userrolesmodels.TypeInput, onSuperTokensAPIError func(err error, req *http.Request, res http.ResponseWriter)) (Recipe, error)