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
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

admin

package

Go to main page

Versions in this module

v2

v2.13.0

Mar 19, 2026

v2.12.0

Mar 17, 2026

v2.11.2

Mar 12, 2026

Changes in this version

type API

+ func (a *API) CreateSessionState(ctx context.Context, sessionID string, req types.CreateSessionStateRequest, ...) (*types.AdminSessionState, error)

+ func (a *API) CreateUserState(ctx context.Context, userID string, req types.CreateUserStateRequest, ...) (*types.AdminUserState, error)

+ func (a *API) UpdateSessionState(ctx context.Context, sessionID string, req types.UpsertSessionStateRequest, ...) (*types.AdminSessionState, error)

+ func (a *API) UpdateUserState(ctx context.Context, userID string, req types.UpsertUserStateRequest, ...) (*types.AdminUserState, error)

v2.11.1

Mar 10, 2026

Changes in this version

+ func Routes(api *API) []models.Route

+ type API struct

+ func NewAPI(useCases *usecases.AdminUseCases, ...) *API

+ func (a *API) BanUser(ctx context.Context, userID string, req types.BanUserRequest, ...) (*types.AdminUserState, error)

+ func (a *API) CreateAccount(ctx context.Context, userID string, request types.CreateAccountRequest) (*models.Account, error)

+ func (a *API) CreateUser(ctx context.Context, request types.CreateUserRequest) (*models.User, error)

+ func (a *API) DeleteAccount(ctx context.Context, accountID string) error

+ func (a *API) DeleteSessionState(ctx context.Context, sessionID string) error

+ func (a *API) DeleteUser(ctx context.Context, userID string) error

+ func (a *API) DeleteUserState(ctx context.Context, userID string) error

+ func (a *API) GetAccountByID(ctx context.Context, accountID string) (*models.Account, error)

+ func (a *API) GetAllImpersonations(ctx context.Context) ([]types.Impersonation, error)

+ func (a *API) GetAllUsers(ctx context.Context, cursor *string, limit int) (*types.UsersPage, error)

+ func (a *API) GetBannedUserStates(ctx context.Context) ([]types.AdminUserState, error)

+ func (a *API) GetImpersonationByID(ctx context.Context, impersonationID string) (*types.Impersonation, error)

+ func (a *API) GetRevokedSessionStates(ctx context.Context) ([]types.AdminSessionState, error)

+ func (a *API) GetSessionState(ctx context.Context, sessionID string) (*types.AdminSessionState, error)

+ func (a *API) GetUserAccounts(ctx context.Context, userID string) ([]models.Account, error)

+ func (a *API) GetUserAdminSessions(ctx context.Context, userID string) ([]types.AdminUserSession, error)

+ func (a *API) GetUserByID(ctx context.Context, userID string) (*models.User, error)

+ func (a *API) GetUserState(ctx context.Context, userID string) (*types.AdminUserState, error)

+ func (a *API) ImpersonationRepository() repositories.ImpersonationRepository

+ func (a *API) RevokeSession(ctx context.Context, sessionID string, reason *string, actorUserID *string) (*types.AdminSessionState, error)

+ func (a *API) SessionStateRepository() repositories.SessionStateRepository

+ func (a *API) StartImpersonation(ctx context.Context, actorUserID string, actorSessionID *string, ...) (*types.StartImpersonationResult, error)

+ func (a *API) StopImpersonation(ctx context.Context, impersonatedUserID string, impersonatedSessionID string, ...) error

+ func (a *API) UnbanUser(ctx context.Context, userID string) (*types.AdminUserState, error)

+ func (a *API) UpdateAccount(ctx context.Context, accountID string, request types.UpdateAccountRequest) (*models.Account, error)

+ func (a *API) UpdateUser(ctx context.Context, userID string, request types.UpdateUserRequest) (*models.User, error)

+ func (a *API) UpsertSessionState(ctx context.Context, sessionID string, req types.UpsertSessionStateRequest, ...) (*types.AdminSessionState, error)

+ func (a *API) UpsertUserState(ctx context.Context, userID string, req types.UpsertUserStateRequest, ...) (*types.AdminUserState, error)

+ func (a *API) UserStateRepository() repositories.UserStateRepository

+ type AdminPlugin struct

+ Api *API

+ func New(config types.AdminPluginConfig) *AdminPlugin

+ func (p *AdminPlugin) Close() error

+ func (p *AdminPlugin) Config() any

+ func (p *AdminPlugin) DependsOn() []string

+ func (p *AdminPlugin) Hooks() []models.Hook

+ func (p *AdminPlugin) Init(ctx *models.PluginContext) error

+ func (p *AdminPlugin) Metadata() models.PluginMetadata

+ func (p *AdminPlugin) Migrations(provider string) []migrations.Migration

+ func (p *AdminPlugin) Routes() []models.Route