tenant

package

v3.1.1 Latest Latest Go to latest Published: May 21, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/aatuh/api-toolkit

Links

Open Source Insights

Documentation ¶

Overview ¶

Package tenant provides stable tenant scoping middleware.

Use the middleware to place a tenant identifier in request context before authorization, idempotency, repositories, or audit logging need tenant-aware behavior. Invalid or missing tenant data should fail at the application edge according to the service's routing policy. Set Options.RequireAllSources when request-carried tenant identifiers must match an authenticated tenant scope or route parameter before the handler runs.

Index ¶

type ErrorHandler
type Middleware
- func New(opts Options) (*Middleware, error)
- func (m *Middleware) Handler(next http.Handler) http.Handler
type Options
type TenantFromContext

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ErrorHandler ¶

type ErrorHandler func(w http.ResponseWriter, r *http.Request, err error)

ErrorHandler handles authorization errors from the tenant middleware.

type Middleware ¶

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

Middleware enforces tenant scoping and stores the tenant in context.

func New ¶

func New(opts Options) (*Middleware, error)

New creates a tenant scoping middleware.

func (*Middleware) Handler ¶

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

Handler wraps the next handler with tenant checks.

type Options ¶

type Options struct {
	Optional          bool
	HeaderName        string
	URLParam          string
	URLParamExtractor ports.URLParamExtractor
	TenantFromContext TenantFromContext
	// RequireAllSources requires every configured tenant source to be present
	// and to agree. Use it when a route must prove the request tenant matches
	// the authenticated tenant scope.
	RequireAllSources bool
	ErrorHandler      ErrorHandler
}

Options configures tenant scoping.

type TenantFromContext ¶

type TenantFromContext func(ctx context.Context) (string, bool)

TenantFromContext extracts a tenant identifier from context.

Source Files ¶

View all Source files

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