permission

Documentation

Index

• Variables
• type ContextType
• type ErrPermissionNotAllowed
  • func (e ErrPermissionNotAllowed) Error() string
• type ErrPermissionNotFound
  • func (e ErrPermissionNotFound) Error() string
• type ErrRoleEventWrongContext
  • func (e ErrRoleEventWrongContext) Error() string
• type PermissionContext
• type RoleEvent
  • func (e *RoleEvent) String() string

Variables

var (
	CtxGlobal          = ContextType("global")
	CtxApp             = ContextType("app")
	CtxTeam            = ContextType("team")
	CtxUser            = ContextType("user")
	CtxPool            = ContextType("pool")
	CtxIaaS            = ContextType("iaas")
	CtxService         = ContextType("service")
	CtxServiceInstance = ContextType("service-instance")
	CtxVolume          = ContextType("volume")

	ContextTypes = []ContextType{
		CtxGlobal, CtxApp, CtxTeam, CtxPool, CtxIaaS, CtxService, CtxServiceInstance,
	}
)

var (
	ErrRoleNotFound          = errors.New("role not found")
	ErrRoleAlreadyExists     = errors.New("role already exists")
	ErrRoleEventNotFound     = errors.New("role event not found")
	ErrInvalidRoleName       = errors.New("invalid role name")
	ErrInvalidPermissionName = errors.New("invalid permission name")
	ErrRemoveRoleWithUsers   = errors.New("role has users assigned. you must dissociate them before remove the role.")

	RoleEventUserCreate = &RoleEvent{
		Name:        "user-create",
		Context:     CtxGlobal,
		Description: "role added to user when user is created",
	}
	RoleEventTeamCreate = &RoleEvent{
		Name:        "team-create",
		Context:     CtxTeam,
		Description: "role added to user when a new team is created",
	}

	RoleEventMap = map[string]*RoleEvent{
		RoleEventUserCreate.Name: RoleEventUserCreate,
		RoleEventTeamCreate.Name: RoleEventTeamCreate,
	}
)

Types

type ContextType

type ContextType string

type ErrPermissionNotAllowed

type ErrPermissionNotAllowed struct {
	Permission  string
	ContextType ContextType
}

func (ErrPermissionNotAllowed) Error

func (e ErrPermissionNotAllowed) Error() string

type ErrPermissionNotFound

type ErrPermissionNotFound struct {
	Permission string
}

func (ErrPermissionNotFound) Error

func (e ErrPermissionNotFound) Error() string

type ErrRoleEventWrongContext

type ErrRoleEventWrongContext struct {
	Expected string
	Role     string
}

func (ErrRoleEventWrongContext) Error

func (e ErrRoleEventWrongContext) Error() string

type PermissionContext

type PermissionContext struct {
	CtxType ContextType
	Value   string
}

type RoleEvent

type RoleEvent struct {
	Name        string
	Context     ContextType
	Description string
}

func (*RoleEvent) String

func (e *RoleEvent) String() string