Documentation
¶
Index ¶
- func Routes(api *API) []models.Route
- type API
- func (a *API) BanUser(ctx context.Context, actor *models.Actor, userID string, ...) (*types.AdminUserState, error)
- func (a *API) CreateAccount(ctx context.Context, actor *models.Actor, userID string, ...) (*models.Account, error)
- func (a *API) CreateSessionState(ctx context.Context, actor *models.Actor, sessionID string, ...) (*types.AdminSessionState, error)
- func (a *API) CreateUser(ctx context.Context, actor *models.Actor, request types.CreateUserRequest) (*models.User, error)
- func (a *API) CreateUserState(ctx context.Context, actor *models.Actor, userID string, ...) (*types.AdminUserState, error)
- func (a *API) DeleteAccount(ctx context.Context, actor *models.Actor, accountID string) error
- func (a *API) DeleteSessionState(ctx context.Context, actor *models.Actor, sessionID string) error
- func (a *API) DeleteUser(ctx context.Context, actor *models.Actor, userID string) error
- func (a *API) DeleteUserState(ctx context.Context, actor *models.Actor, userID string) error
- func (a *API) GetAccountByID(ctx context.Context, actor *models.Actor, accountID string) (*models.Account, error)
- func (a *API) GetAllImpersonations(ctx context.Context, actor *models.Actor) ([]types.Impersonation, error)
- func (a *API) GetAllUsers(ctx context.Context, actor *models.Actor, cursor *string, limit int) (*types.UsersPage, error)
- func (a *API) GetBannedUserStates(ctx context.Context, actor *models.Actor) ([]types.AdminUserState, error)
- func (a *API) GetImpersonationByID(ctx context.Context, actor *models.Actor, impersonationID string) (*types.Impersonation, error)
- func (a *API) GetRevokedSessionStates(ctx context.Context, actor *models.Actor) ([]types.AdminSessionState, error)
- func (a *API) GetSelfSessionState(ctx context.Context, sessionID string) (*types.AdminSessionState, error)
- func (a *API) GetSelfUserState(ctx context.Context, actor *models.Actor, userID string) (*types.AdminUserState, error)
- func (a *API) GetSessionState(ctx context.Context, actor *models.Actor, sessionID string) (*types.AdminSessionState, error)
- func (a *API) GetUserAccounts(ctx context.Context, actor *models.Actor, userID string) ([]models.Account, error)
- func (a *API) GetUserAdminSessions(ctx context.Context, actor *models.Actor, userID string) ([]types.AdminUserSession, error)
- func (a *API) GetUserByID(ctx context.Context, actor *models.Actor, userID string) (*models.User, error)
- func (a *API) GetUserState(ctx context.Context, actor *models.Actor, userID string) (*types.AdminUserState, error)
- func (a *API) ImpersonationRepository() repositories.ImpersonationRepository
- func (a *API) RevokeSession(ctx context.Context, actor *models.Actor, sessionID string, reason *string, ...) (*types.AdminSessionState, error)
- func (a *API) SessionStateRepository() repositories.SessionStateRepository
- func (a *API) StartImpersonation(ctx context.Context, actor *models.Actor, actorUserID string, ...) (*types.StartImpersonationResult, error)
- func (a *API) StopImpersonation(ctx context.Context, actor *models.Actor, impersonatedUserID string, ...) error
- func (a *API) UnbanUser(ctx context.Context, actor *models.Actor, userID string) (*types.AdminUserState, error)
- func (a *API) UpdateAccount(ctx context.Context, actor *models.Actor, accountID string, ...) (*models.Account, error)
- func (a *API) UpdateSessionState(ctx context.Context, actor *models.Actor, sessionID string, ...) (*types.AdminSessionState, error)
- func (a *API) UpdateUser(ctx context.Context, actor *models.Actor, userID string, ...) (*models.User, error)
- func (a *API) UpdateUserState(ctx context.Context, actor *models.Actor, userID string, ...) (*types.AdminUserState, error)
- func (a *API) UpsertSessionState(ctx context.Context, actor *models.Actor, sessionID string, ...) (*types.AdminSessionState, error)
- func (a *API) UpsertUserState(ctx context.Context, actor *models.Actor, userID string, ...) (*types.AdminUserState, error)
- func (a *API) UserStateRepository() repositories.UserStateRepository
- type 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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
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) CreateAccount ¶
func (*API) CreateSessionState ¶
func (*API) CreateUser ¶
func (*API) CreateUserState ¶
func (*API) DeleteAccount ¶
func (*API) DeleteSessionState ¶
func (*API) DeleteUser ¶
func (*API) DeleteUserState ¶
func (*API) GetAccountByID ¶
func (*API) GetAllImpersonations ¶
func (*API) GetAllUsers ¶
func (*API) GetBannedUserStates ¶
func (*API) GetImpersonationByID ¶
func (*API) GetRevokedSessionStates ¶
func (*API) GetSelfSessionState ¶ added in v1.13.0
func (*API) GetSelfUserState ¶ added in v1.13.0
func (*API) GetSessionState ¶
func (*API) GetUserAccounts ¶
func (*API) GetUserAdminSessions ¶
func (*API) GetUserByID ¶
func (*API) GetUserState ¶
func (*API) ImpersonationRepository ¶
func (a *API) ImpersonationRepository() repositories.ImpersonationRepository
func (*API) RevokeSession ¶
func (*API) SessionStateRepository ¶
func (a *API) SessionStateRepository() repositories.SessionStateRepository
func (*API) StartImpersonation ¶
func (*API) StopImpersonation ¶
func (*API) UpdateAccount ¶
func (*API) UpdateSessionState ¶
func (*API) UpdateUser ¶
func (*API) UpdateUserState ¶
func (*API) UpsertSessionState ¶
func (*API) UpsertUserState ¶
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
Click to show internal directories.
Click to hide internal directories.