admin

Documentation

Overview

Package admin contains controllers for system wide administrative actions.

Index

• Constants
• type Controller
  • func New(config *config.ServerConfig, cacher cache.Cacher, db *database.Database, ...) *Controller
  • func (c *Controller) HandleCachesClear() http.Handler
  • func (c *Controller) HandleCachesIndex() http.Handler
  • func (c *Controller) HandleEmailUpdate() http.Handler
  • func (c *Controller) HandleEventsShow() http.Handler
  • func (c *Controller) HandleInfoShow() http.Handler
  • func (c *Controller) HandleMobileAppsShow() http.Handler
  • func (c *Controller) HandleRealmsAdd() http.Handler
  • func (c *Controller) HandleRealmsCreate() http.Handler
  • func (c *Controller) HandleRealmsIndex() http.Handler
  • func (c *Controller) HandleRealmsRemove() http.Handler
  • func (c *Controller) HandleRealmsUpdate() http.Handler
  • func (c *Controller) HandleSMSUpdate() http.Handler
  • func (c *Controller) HandleSystemAdminCreate() http.Handler
  • func (c *Controller) HandleSystemAdminRevoke() http.Handler
  • func (c *Controller) HandleUserDelete() http.Handler
  • func (c *Controller) HandleUserShow() http.Handler
  • func (c *Controller) HandleUsersIndex() http.Handler

Constants

const (
	// QueryFromSearch is the query key for a starting time.
	QueryFromSearch = "from"

	// QueryToSearch is the query key for an ending time.
	QueryToSearch = "to"

	// QueryRealmIDSearch is the query key to filter by realmID.
	QueryRealmIDSearch = "realm_id"

	// QueryIncludeTest is the query key to filter on events from test or not.
	QueryIncludeTest = "include_test"
)

const (
	// QueryKeySearch is the query key where the search query exists.
	QueryKeySearch = "q"
)

Types

type Controller

type Controller struct {
	// contains filtered or unexported fields
}

func New

func New(
	config *config.ServerConfig,
	cacher cache.Cacher,
	db *database.Database,
	authProvider auth.Provider,
	limiter limiter.Store,
	h *render.Renderer,
) *Controller

func (*Controller) HandleCachesClear

func (c *Controller) HandleCachesClear() http.Handler

HandleCachesClear clears the given caches.

func (*Controller) HandleCachesIndex

func (c *Controller) HandleCachesIndex() http.Handler

HandleCachesIndex shows the caches page.

func (*Controller) HandleEmailUpdate

func (c *Controller) HandleEmailUpdate() http.Handler

HandleEmailUpdate creates or updates the Email config.

func (*Controller) HandleEventsShow

func (c *Controller) HandleEventsShow() http.Handler

HandleEventsShow shows event logs.

func (*Controller) HandleInfoShow

func (c *Controller) HandleInfoShow() http.Handler

HandleInfoShow renders the list of system admins.

func (*Controller) HandleMobileAppsShow

func (c *Controller) HandleMobileAppsShow() http.Handler

HandleMobileAppsShow shows the configured mobile apps.

func (*Controller) HandleRealmsAdd

func (c *Controller) HandleRealmsAdd() http.Handler

func (*Controller) HandleRealmsCreate

func (c *Controller) HandleRealmsCreate() http.Handler

func (*Controller) HandleRealmsIndex

func (c *Controller) HandleRealmsIndex() http.Handler

func (*Controller) HandleRealmsRemove

func (c *Controller) HandleRealmsRemove() http.Handler

func (*Controller) HandleRealmsUpdate

func (c *Controller) HandleRealmsUpdate() http.Handler

func (*Controller) HandleSMSUpdate

func (c *Controller) HandleSMSUpdate() http.Handler

HandleSMSUpdate creates or updates the SMS config.

func (*Controller) HandleSystemAdminCreate

func (c *Controller) HandleSystemAdminCreate() http.Handler

HandleSystemAdminCreate creates a new system admin.

func (*Controller) HandleSystemAdminRevoke

func (c *Controller) HandleSystemAdminRevoke() http.Handler

HandleSystemAdminRevoke removes admin from a system admin.

func (*Controller) HandleUserDelete

func (c *Controller) HandleUserDelete() http.Handler

HandleUserDelete deletes a user from the system.

func (*Controller) HandleUserShow

func (c *Controller) HandleUserShow() http.Handler

HandleUserShow renders details about a user.

func (*Controller) HandleUsersIndex

func (c *Controller) HandleUsersIndex() http.Handler

HandleUsersIndex renders the list of all non-system-admin users.