admin

Documentation

Index

• func Routes(api *API) []models.Route
• type API
  • 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) CreateSessionState(ctx context.Context, sessionID string, req types.CreateSessionStateRequest, ...) (*types.AdminSessionState, error)
  • func (a *API) CreateUser(ctx context.Context, request types.CreateUserRequest) (*models.User, error)
  • func (a *API) CreateUserState(ctx context.Context, userID string, req types.CreateUserStateRequest, ...) (*types.AdminUserState, 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) UpdateSessionState(ctx context.Context, sessionID string, req types.UpsertSessionStateRequest, ...) (*types.AdminSessionState, error)
  • func (a *API) UpdateUser(ctx context.Context, userID string, request types.UpdateUserRequest) (*models.User, error)
  • func (a *API) UpdateUserState(ctx context.Context, userID string, req types.UpsertUserStateRequest, ...) (*types.AdminUserState, 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
  • 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

Functions

func Routes

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

Types

type API

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

func NewAPI

func NewAPI(
	useCases *usecases.AdminUseCases,
	impersonationRepo repositories.ImpersonationRepository,
	userStateRepo repositories.UserStateRepository,
	sessionStateRepo repositories.SessionStateRepository,
) *API

func (*API) BanUser

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

func (*API) CreateAccount

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

func (*API) CreateSessionState

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

func (*API) CreateUser

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

func (*API) CreateUserState

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

func (*API) DeleteAccount

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

func (*API) DeleteSessionState

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

func (*API) DeleteUser

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

func (*API) DeleteUserState

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

func (*API) GetAccountByID

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

func (*API) GetAllImpersonations

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

func (*API) GetAllUsers

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

func (*API) GetBannedUserStates

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

func (*API) GetImpersonationByID

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

func (*API) GetRevokedSessionStates

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

func (*API) GetSessionState

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

func (*API) GetUserAccounts

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

func (*API) GetUserAdminSessions

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

func (*API) GetUserByID

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

func (*API) GetUserState

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

func (*API) ImpersonationRepository

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

func (*API) RevokeSession

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

func (*API) SessionStateRepository

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

func (*API) StartImpersonation

func (a *API) StartImpersonation(ctx context.Context, actorUserID string, actorSessionID *string, ipAddress *string, userAgent *string, req types.StartImpersonationRequest) (*types.StartImpersonationResult, error)

func (*API) StopImpersonation

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

func (*API) UnbanUser

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

func (*API) UpdateAccount

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

func (*API) UpdateSessionState

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

func (*API) UpdateUser

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

func (*API) UpdateUserState

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

func (*API) UpsertSessionState

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

func (*API) UpsertUserState

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

func (*API) UserStateRepository

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

type AdminPlugin

type AdminPlugin struct {
	Api *API
	// contains filtered or unexported fields
}

func New

func New(config types.AdminPluginConfig) *AdminPlugin

func (*AdminPlugin) Close

func (p *AdminPlugin) Close() error

func (*AdminPlugin) Config

func (p *AdminPlugin) Config() any

func (*AdminPlugin) DependsOn

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

func (*AdminPlugin) Hooks

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

func (*AdminPlugin) Init

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

func (*AdminPlugin) Metadata

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

func (*AdminPlugin) Migrations

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

func (*AdminPlugin) Routes

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