api

package

Go to main page

Versions in this module

v0

v0.9.0

May 2, 2026

v0.8.1

Feb 18, 2026

v0.8.0

Feb 12, 2026

Changes in this version

type CreateIncidentRequest

+ AuditLogIDs []string

type CreateVulnerabilityRequest

+ AffectedSystem string

+ RemediationPlan string

type IncidentResponse

+ AuditLogIDs []string

type MFAVerifyRequest

+ Token string

type UpdateVulnerabilityRequest

+ RemediationPlan string

type VulnerabilityResponse

+ AffectedSystem string

+ CVE string

+ RemediationPlan string

+ ResolvedAt string

v0.7.1

Aug 13, 2025

v0.7.0

Aug 13, 2025

v0.6.2-security-analysis

Jul 3, 2025

v0.6.1

Jul 3, 2025

v0.6.0

Jul 3, 2025

v0.5.0

Jun 20, 2025

v0.4.0

Jun 20, 2025

v0.3.0

Jun 20, 2025

v0.2.0

Jun 20, 2025

v0.2.0-stable

Jun 20, 2025

v0.1.1

Jun 20, 2025

v0.1.0

Jun 20, 2025

Changes in this version

+ func WriteErrorResponse(w http.ResponseWriter, statusCode int, message string)

+ func WriteJSON(w http.ResponseWriter, statusCode int, data interface{})

+ func WriteSuccessResponse(w http.ResponseWriter, statusCode int, message string, data interface{})

+ type APIConfig struct

+ AllowedOrigins []string

+ BasePath string

+ EnableCORS bool

+ EnableRateLimit bool

+ EnableRequestLogging bool

+ Port int

+ RateLimitPerMinute int

+ func DefaultAPIConfig() *APIConfig

+ type AddPermissionRequest struct

+ Permission string

+ type AuditLogResponse struct

+ Action string

+ Details map[string]interface{}

+ ID string

+ IPAddress string

+ Metadata map[string]interface{}

+ Resource string

+ ResourceID string

+ Severity string

+ Status string

+ Timestamp string

+ UserAgent string

+ UserID string

+ Username string

+ type AuthMiddleware struct

+ func NewAuthMiddleware(accessManager access.AccessControlManager) *AuthMiddleware

+ func (m *AuthMiddleware) Middleware(next http.Handler) http.Handler

+ type BackupCodesResponse struct

+ Codes []string

+ Generated time.Time

+ type CreateIncidentRequest struct

+ AffectedResources []string

+ Description string

+ Metadata map[string]interface{}

+ Severity string

+ Tags []string

+ Title string

+ type CreateRoleRequest struct

+ Description string

+ Name string

+ ParentRoles []string

+ Permissions []string

+ type CreateUserRequest struct

+ Email string

+ MFAEnabled bool

+ MFAMethods []common.AuthMethod

+ Metadata map[string]interface{}

+ Password string

+ Permissions []string

+ Roles []string

+ Username string

+ type CreateVulnerabilityRequest struct

+ AffectedSystems []string

+ CVEID string

+ Description string

+ Metadata map[string]interface{}

+ RemediationSteps string

+ Severity string

+ Tags []string

+ Title string

+ type IncidentResponse struct

+ AffectedResources []string

+ AssignedTo string

+ CreatedAt string

+ Description string

+ ID string

+ Metadata map[string]interface{}

+ ReportedBy string

+ ResolutionNotes string

+ ResolvedAt string

+ Severity string

+ Status string

+ Tags []string

+ Title string

+ UpdatedAt string

+ type LoggingMiddleware struct

+ func NewLoggingMiddleware(accessManager access.AccessControlManager) *LoggingMiddleware

+ func (m *LoggingMiddleware) Middleware(next http.Handler) http.Handler

+ type LoginRequest struct

+ Password string

+ Username string

+ type LoginResponse struct

+ Email string

+ ExpiresAt int64

+ MFAMethods []string

+ MFARequired bool

+ RefreshToken string

+ Token string

+ UserID string

+ Username string

+ type MFAHandler struct

+ func NewMFAHandler(authManager *access.AuthManager) *MFAHandler

+ func (h *MFAHandler) RegisterRoutes(router *http.ServeMux)

+ type MFASetupRequest struct

+ Method common.AuthMethod

+ type MFAStatusResponse struct

+ DefaultMethod common.AuthMethod

+ Enabled bool

+ LastUpdated time.Time

+ Methods []common.AuthMethod

+ type MFAVerifyRequest struct

+ Code string

+ Method common.AuthMethod

+ type ManageMFARequest struct

+ Enabled bool

+ Methods []string

+ type RBACMiddleware struct

+ func NewRBACMiddleware(accessManager access.AccessControlManager) *RBACMiddleware

+ func (m *RBACMiddleware) RequirePermission(permission access.Permission) func(http.Handler) http.Handler

+ func (m *RBACMiddleware) RequireRole(role string) func(http.Handler) http.Handler

+ type RateLimitMiddleware struct

+ func NewRateLimitMiddleware(requestsPerMinute int) *RateLimitMiddleware

+ func (m *RateLimitMiddleware) Middleware(next http.Handler) http.Handler

+ func (m *RateLimitMiddleware) Stop()

+ type RefreshTokenRequest struct

+ RefreshToken string

+ type RequestContext interface

+ GetIPAddress func() string

+ GetUserAgent func() string

+ GetUserID func() string

+ GetUsername func() string

+ func NewRequestContext(ctx context.Context, userID, username, ipAddress, userAgent string) RequestContext

+ type ResetPasswordRequest struct

+ Password string

+ type Response struct

+ Data interface{}

+ Error string

+ Message string

+ Success bool

+ type RoleResponse struct

+ Description string

+ IsBuiltIn bool

+ Name string

+ ParentRoles []string

+ Permissions []string

+ type SMSSetupRequest struct

+ PhoneNumber string

+ type Server struct

+ func NewServer(config *APIConfig, accessManager access.AccessControlManager) *Server

+ func (s *Server) Start() error

+ func (s *Server) Stop(ctx context.Context) error

+ type TOTPSetupResponse struct

+ QRCodeURL string

+ Secret string

+ type UpdateIncidentRequest struct

+ AffectedResources []string

+ AssignedTo string

+ Description string

+ Metadata map[string]interface{}

+ ResolutionNotes string

+ Severity string

+ Status string

+ Tags []string

+ Title string

+ type UpdateRoleRequest struct

+ Description string

+ ParentRoles []string

+ type UpdateUserRequest struct

+ Active *bool

+ Email string

+ MFAEnabled *bool

+ MFAMethods []common.AuthMethod

+ Metadata map[string]interface{}

+ Permissions []string

+ Roles []string

+ type UpdateVulnerabilityRequest struct

+ AffectedSystems []string

+ AssignedTo string

+ CVEID string

+ Description string

+ Metadata map[string]interface{}

+ PatchNotes string

+ RemediationSteps string

+ Severity string

+ Status string

+ Tags []string

+ Title string

+ type UserResponse struct

+ Active bool

+ CreatedAt string

+ Email string

+ ID string

+ LastLogin string

+ Locked bool

+ MFAEnabled bool

+ MFAMethods []string

+ Metadata map[string]interface{}

+ Permissions []string

+ Roles []string

+ UpdatedAt string

+ Username string

+ type VulnerabilityResponse struct

+ AffectedSystems []string

+ AssignedTo string

+ CVEID string

+ CreatedAt string

+ Description string

+ ID string

+ Metadata map[string]interface{}

+ PatchNotes string

+ PatchedAt string

+ RemediationSteps string

+ ReportedBy string

+ Severity string

+ Status string

+ Tags []string

+ Title string

+ UpdatedAt string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL