Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

users

package

Go to main page

Versions in this module

v1

v1.22.0-rc.0

Sep 12, 2026

v1.21.1

Jun 5, 2026

v1.21.1-rc.0

May 31, 2026

v1.21.0

Apr 25, 2026

Changes in this version

+ const GlobalMarkersDir

+ const TenantDeletionMarkFile

+ const UserIndexCompressedFilename

+ const UserIndexFilename

+ const UserScanStrategyList

+ const UserScanStrategyUserIndex

+ var ErrIndexCorrupted = errors.New("user index corrupted")

+ var ErrIndexNotFound = errors.New("user index not found")

+ var ErrInvalidCacheTTL = errors.New("cache TTL must be >= 0")

+ var ErrInvalidMaxStalePeriod = errors.New("max stale period must be positive")

+ var ErrInvalidUserScannerStrategy = errors.New("invalid user scanner strategy")

+ func CheckTenantIDIsSupported(s string) error

+ func CheckTenantIDLength(s string) error

+ func DeleteTenantDeletionMark(ctx context.Context, bkt objstore.Bucket, userID string) error

+ func ExtractTenantIDFromHTTPRequest(req *http.Request) (string, context.Context, error)

+ func GetGlobalDeletionMarkPath(userID string) string

+ func GetLocalDeletionMarkPath(userID string) string

+ func JoinTenantIDs(tenantIDs []string) string

+ func NormalizeTenantIDs(tenantIDs []string) []string

+ func ShardByUser(userID string) uint32

+ func TenantDeletionMarkExists(ctx context.Context, bkt objstore.BucketReader, userID string) (bool, error)

+ func TenantID(ctx context.Context) (string, error)

+ func TenantIDs(ctx context.Context) ([]string, error)

+ func TenantIDsFromOrgID(orgID string) ([]string, error)

+ func ValidTenantID(s string) error

+ func ValidateOrgIDs(orgIDs []string) ([]string, error)

+ func WithDefaultResolver(r Resolver)

+ func WriteTenantDeletionMark(ctx context.Context, bkt objstore.InstrumentedBucket, userID string, ...) error

+ func WriteUserIndex(ctx context.Context, bkt objstore.Bucket, idx *UserIndex) error

+ type ActiveUsers struct

+ func NewActiveUsers() *ActiveUsers

+ func (m *ActiveUsers) ActiveUsers(deadline int64) []string

+ func (m *ActiveUsers) PurgeInactiveUsers(deadline int64) []string

+ func (m *ActiveUsers) UpdateUserTimestamp(userID string, ts int64)

+ type ActiveUsersCleanupService struct

+ func NewActiveUsersCleanupService(cleanupInterval, inactiveTimeout time.Duration, cleanupFn func(string)) *ActiveUsersCleanupService

+ func NewActiveUsersCleanupWithDefaultValues(cleanupFn func(string)) *ActiveUsersCleanupService

+ func (s *ActiveUsersCleanupService) ActiveUsers() []string

+ func (s *ActiveUsersCleanupService) UpdateUserTimestamp(user string, now time.Time)

+ type AllowedTenants struct

+ func NewAllowedTenants(enabled []string, disabled []string) *AllowedTenants

+ func (a *AllowedTenants) IsAllowed(tenantID string) bool

+ type MultiResolver struct

+ func NewMultiResolver() *MultiResolver

+ func (t *MultiResolver) TenantID(ctx context.Context) (string, error)

+ func (t *MultiResolver) TenantIDs(ctx context.Context) ([]string, error)

+ type Resolver interface

+ TenantID func(context.Context) (string, error)

+ TenantIDs func(context.Context) ([]string, error)

+ type Scanner interface

+ ScanUsers func(ctx context.Context) (active, deleting, deleted []string, err error)

+ func NewScanner(cfg UsersScannerConfig, bkt objstore.InstrumentedBucket, logger log.Logger, ...) (Scanner, error)

+ func NewShardedScanner(scanner Scanner, isOwned func(userID string) (bool, error), logger log.Logger) Scanner

+ type SingleResolver struct

+ func NewSingleResolver() *SingleResolver

+ func (t *SingleResolver) TenantID(ctx context.Context) (string, error)

+ func (t *SingleResolver) TenantIDs(ctx context.Context) ([]string, error)

+ type TenantDeletionMark struct

+ DeletionTime int64

+ FinishedTime int64

+ func NewTenantDeletionMark(deletionTime time.Time) *TenantDeletionMark

+ func ReadTenantDeletionMark(ctx context.Context, bkt objstore.InstrumentedBucket, userID string, ...) (*TenantDeletionMark, error)

+ type UserIndex struct

+ ActiveUsers []string

+ DeletedUsers []string

+ DeletingUsers []string

+ UpdatedAt int64

+ Version int

+ func ReadUserIndex(ctx context.Context, bkt objstore.InstrumentedBucket, logger log.Logger) (*UserIndex, error)

+ func (idx *UserIndex) GetUpdatedAt() time.Time

+ type UserIndexUpdater struct

+ func NewUserIndexUpdater(bkt objstore.InstrumentedBucket, updateInterval time.Duration, scanner Scanner, ...) *UserIndexUpdater

+ func (u *UserIndexUpdater) GetUpdateInterval() time.Duration

+ func (u *UserIndexUpdater) UpdateUserIndex(ctx context.Context) error

+ type UsersScannerConfig struct

+ CacheTTL time.Duration

+ MaxStalePeriod time.Duration

+ Strategy string

+ UpdateInterval time.Duration

+ func (c *UsersScannerConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

+ func (c *UsersScannerConfig) Validate() error

v1.21.0-rc.1

Apr 18, 2026

v1.21.0-rc.0

Mar 13, 2026