Prescriptoo Docs

Appearance

module ​

go
import "github.com/prescriptoo/prescriptoo-api/services/identity/module"

Package module provides the identity service boundary for the monolith.

Index ​

func ValidateConfig ​

go
func ValidateConfig(env config.Env) error

ValidateConfig rejects missing signing keys and unreasonable/overflowing TTLs.

type Module ​

Module exposes identity HTTP operations to the monolith.

go
type Module struct {
    module.Module
    // contains filtered or unexported fields
}

func NewModule ​

go
func NewModule(bus events.Bus, db *pgxpool.Pool, env config.Env, sender email.Sender) (*Module, error)

NewModule permits a nil database only for documentation and route tests. Such a module returns 503 from authentication operations and never issues credentials.

func (*Module) AccountStatuses ​

go
func (m *Module) AccountStatuses() identitypublic.AccountStatusManager

AccountStatuses returns the Identity-owned administrative status capability.

func (*Module) ActiveAccounts ​

go
func (m *Module) ActiveAccounts() identitypublic.ActiveAccountLocker

ActiveAccounts exposes Identity's account-lock capability to affiliation writers. The returned adapter participates in the supplied business transaction and does not change account state, create sessions, or require an audit writer of its own.

func (*Module) Administration ​

go
func (m *Module) Administration() identitypublic.AdminIdentityService

Administration returns the account provisioning and lookup service used by Admin.

func (*Module) Authentication ​

go
func (m *Module) Authentication() identitypublic.AuthenticationService

Authentication returns credential authentication with an optional eligibility check.

func (*Module) ConfigureAudit ​

go
func (m *Module) ConfigureAudit(writer audit.TransactionalRecorderFactory)

ConfigureAudit enables mandatory recording on the provider's persistent mutations.

func (*Module) Identity ​

go
func (m *Module) Identity() types.IIdentityService

Identity returns the shared identity-verification service.

func (*Module) RegisterHuma ​

go
func (m *Module) RegisterHuma(api huma.API, _ *pgxpool.Pool)

RegisterHuma registers identity HTTP operations on the shared API.

func (*Module) Registration ​

go
func (m *Module) Registration() identity.TransactionalRegistration

Registration exposes account creation for atomic cross-service onboarding.

Generated by gomarkdoc

Documentation follows the source. Planned contracts are marked explicitly.