auth

Documentation

Index

• Constants
• type API
  • func NewApi(sessionStore libsession.Store, providers []security.Provider) API

Constants

const (
	// UserKey is the context name for user credential.
	UserKey = "user_id"
	// ApiKey is the context name for user api key.
	ApiKey = "api_key"
	// RoleKey is the context name for user's role
	RoleKey = "role"
)

Types

type API

type API interface {
	// LogoutHandler deletes session.
	LogoutHandler() gin.HandlerFunc
	// LoginHandler authenticates user and starts sessions.
	LoginHandler() gin.HandlerFunc
	// GetSessionsCount returns active sessions count.
	GetSessionsCount() gin.HandlerFunc
}

func NewApi

func NewApi(
	sessionStore libsession.Store,
	providers []security.Provider,
) API