auth

Documentation

Index

• Constants
• type API
  • func NewApi(tokenService apisecurity.TokenService, tokenProviders []security.TokenProvider, ...) API
• type LoggedUserCountResponse
• type LoginRequest
• type LoginResponse

Constants

const (
	// UserKey is the context name for user credential.
	UserKey  = "user_id"
	Username = "username"
	// ApiKey is the context name for user api key.
	ApiKey = "api_key"
	// RolesKey is the context name for user's roles
	RolesKey = "roles"
)

Types

type API

type API interface {
	Login(c *gin.Context)
	Logout(c *gin.Context)
	GetLoggedUserCount(c *gin.Context)
	GetFileAccess(c *gin.Context)
}

func NewApi

func NewApi(
	tokenService apisecurity.TokenService,
	tokenProviders []security.TokenProvider,
	providers []security.Provider,
	websocketStore websocket.Store,
	maintenanceAdapter config.MaintenanceAdapter,
	enforcer security.Enforcer,
	cookieName string,
	cookieMaxAge int,
	logger zerolog.Logger,
) API

type LoggedUserCountResponse

type LoggedUserCountResponse struct {
	Count int64 `json:"count"`
}

type LoginRequest

type LoginRequest struct {
	Username string `form:"username" json:"username" binding:"required"`
	Password string `form:"password" json:"password" binding:"required"`
}

type LoginResponse

type LoginResponse struct {
	AccessToken string `json:"access_token"`
}