groups

Documentation

Index

• Variables
• type Database
  • func GetDatabase(r api.Router) Database

Variables

var Module = api.Module{
	Name: "groups",
	Setup: func(r api.Router) error {
		return newGroupModule().setup(r)
	},
}

Types

type Database

type Database interface {
	// AssignUserToGroup adds accountID to groupID
	AssignUserToGroup(groupID uint, accountID string) error

	// DeleteUserFromGroup removes accountID from groupID
	DeleteUserFromGroup(groupID uint, accountID string) error

	// CreateGroup creates a new group
	CreateGroup(name, description string) (*iam.Group, error)

	// GetGroupUsers returns all users being part of groupID
	GetGroupUsers(groupID uint) ([]*iam.User, error)

	// ListGroups returns all registered groups
	ListGroups() ([]*iam.Group, error)

	// GetGroupByID returns the group with the given ID
	GetGroup(id uint) (*iam.Group, error)

	// UpdateGroup updates the group with the given ID
	UpdateGroup(id uint, group *iam.Group) (*iam.Group, error)

	// DeleteGroup deletes the group with the given ID
	DeleteGroup(id uint) error
}

Database encapsulates database access for group management

func GetDatabase

func GetDatabase(r api.Router) Database

GetDatabase returns the Database associated with r