Glossary
| Term | Definition |
|---|---|
instanceId |
Tenant identifier. Every record (user, address, consent, list, note, payment profile, attribute) is scoped to an instanceId. Cache keys are namespaced by instanceId. |
identifier |
User’s unique identifier — either a UUID or an Identity Provider UserSub (e.g., Cognito sub claim). |
businessId |
Numeric tenant ID on the instance document and in JWT claims. Used by eq-authservices for role lookups. |
inviteFlag |
Boolean distinguishing admin-invited users (true) from self-registered users (false). Determines INVITATION vs WELCOME notification. |
| User type | REGISTER=1 (standard shopper), GUEST=2 (anonymous), SUBSCRIBE=3 (subscriber), ADMIN=4 (admin user) |
| User status | ACTIVE, NOT_ACTIVATED (registered but not confirmed), INACTIVE (deactivated), DELETED (GDPR erasure pending) |
instance_attributes |
Schema definitions for allowed instance property keys. instanceId="-1" = platform-wide defaults. Managed via Webbox migrations only. |
pluginConfig |
Free-form object in instance.properties.pluginConfig configuring SSO providers, IAM connectors, notification mappings, and validator plugins. |
IamInvoker |
Single entry point for all IAM operations. Checks for marketplace IAM connector first; falls back to bundled native IDP connector. |
MarketplaceServiceAdapter |
SDK class routing operations to dynamically installed marketplace connector apps. |
| Extension / Plugin | Dynamically loaded JS module (Lambda Layer / EFS / S3) implementing a validator or lifecycle interface. Loaded via @equinox/plugin-registry. |
PreHandleExtension |
Lifecycle extension executing BEFORE controller logic (quota checking, auth enrichment). |
PostHandleExtension |
Lifecycle extension executing AFTER controller logic but BEFORE response is sent (data masking, audit logging). |
| Act-on-behalf | CSR impersonation. V1: JWT embedded in URL. V2: short-lived one-time code exchanged at /v1/userservice/exchange. |
| GDPR Delete | PII anonymization workflow: marks user DELETED → waits for retention period → anonymizes data via Step Functions. |
| GDPR Export | Data portability: exports all user PII as an Excel file to S3 via Step Functions. |
| Guest user | Anonymous user (type=2). Created without authentication. Merged into registered user on login if isUserMergeEnabled=true. |
| Blacklist | Blocklist of identifiers prevented from registering. Can be GLOBAL (platform-wide) or instance-scoped. |
searchConfig |
Per-instance Typesense search configuration: synonym sets, boost rules, sort configurations. |
| Circuit breaker | Automatic failover for Typesense. In OPEN state, requests fail fast and MongoDB fallback is used. State stored in Redis. |
| Webbox | Equinox’s MongoDB migration framework (like Liquibase). Migrations auto-run on startup. |
UserSub |
AWS Cognito’s per-user unique identifier — used as the identifier field in the user document. |
Revision History
2026-08-04 | JP – Created the page and added the content.