userrolesmodels

Documentation

Index

• type APIInterface
• type AddRoleToUserResponse
• type CreateNewRoleOrAddPermissionsResponse
• type DeleteRoleResponse
• type GetAllRolesResponse
• type GetPermissionsForRoleResponse
• type GetRolesForUserResponse
• type GetRolesThatHavePermissionResponse
• type GetUsersThatHaveRoleResponse
• type OverrideStruct
• type RecipeInterface
• type RemovePermissionsFromRoleResponse
• type RemoveUserRoleResponse
• type TypeInput
• type TypeNormalisedInput
• type UnknownRoleError

Types

type APIInterface

type APIInterface struct {
}

type AddRoleToUserResponse

type AddRoleToUserResponse struct {
	OK *struct {
		DidUserAlreadyHaveRole bool
	}
	UnknownRoleError *UnknownRoleError
}

type CreateNewRoleOrAddPermissionsResponse

type CreateNewRoleOrAddPermissionsResponse struct {
	OK *struct {
		CreatedNewRole bool
	}
}

type DeleteRoleResponse

type DeleteRoleResponse struct {
	OK *struct {
		DidRoleExist bool
	}
}

type GetAllRolesResponse

type GetAllRolesResponse struct {
	OK *struct {
		Roles []string
	}
}

type GetPermissionsForRoleResponse

type GetPermissionsForRoleResponse struct {
	OK *struct {
		Permissions []string
	}
	UnknownRoleError *UnknownRoleError
}

type GetRolesForUserResponse

type GetRolesForUserResponse struct {
	OK *struct {
		Roles []string
	}
}

type GetRolesThatHavePermissionResponse

type GetRolesThatHavePermissionResponse struct {
	OK *struct {
		Roles []string
	}
}

type GetUsersThatHaveRoleResponse

type GetUsersThatHaveRoleResponse struct {
	OK *struct {
		Users []string
	}
	UnknownRoleError *UnknownRoleError
}

type OverrideStruct

type OverrideStruct struct {
	Functions func(originalImplementation RecipeInterface) RecipeInterface
	APIs      func(originalImplementation APIInterface) APIInterface
}

type RecipeInterface

type RecipeInterface struct {
	AddRoleToUser                 *func(userID string, role string, userContext supertokens.UserContext) (AddRoleToUserResponse, error)
	RemoveUserRole                *func(userID string, role string, userContext supertokens.UserContext) (RemoveUserRoleResponse, error)
	GetRolesForUser               *func(userID string, userContext supertokens.UserContext) (GetRolesForUserResponse, error)
	GetUsersThatHaveRole          *func(role string, userContext supertokens.UserContext) (GetUsersThatHaveRoleResponse, error)
	CreateNewRoleOrAddPermissions *func(role string, permissions []string, userContext supertokens.UserContext) (CreateNewRoleOrAddPermissionsResponse, error)
	GetPermissionsForRole         *func(role string, userContext supertokens.UserContext) (GetPermissionsForRoleResponse, error)
	RemovePermissionsFromRole     *func(role string, permissions []string, userContext supertokens.UserContext) (RemovePermissionsFromRoleResponse, error)
	GetRolesThatHavePermission    *func(permission string, userContext supertokens.UserContext) (GetRolesThatHavePermissionResponse, error)
	DeleteRole                    *func(role string, userContext supertokens.UserContext) (DeleteRoleResponse, error)
	GetAllRoles                   *func(userContext supertokens.UserContext) (GetAllRolesResponse, error)
}

type RemovePermissionsFromRoleResponse

type RemovePermissionsFromRoleResponse struct {
	OK               *struct{}
	UnknownRoleError *UnknownRoleError
}

type RemoveUserRoleResponse

type RemoveUserRoleResponse struct {
	OK *struct {
		DidUserHaveRole bool
	}
	UnknownRoleError *UnknownRoleError
}

type TypeInput

type TypeInput struct {
	SkipAddingRolesToAccessToken       bool
	SkipAddingPermissionsToAccessToken bool

	Override *OverrideStruct
}

type TypeNormalisedInput

type TypeNormalisedInput struct {
	SkipAddingRolesToAccessToken       bool
	SkipAddingPermissionsToAccessToken bool

	Override OverrideStruct
}

type UnknownRoleError

type UnknownRoleError struct {
}