alepha@docs:~/docs/reference/primitives$
cat $realm.md | pretty2 min read
#$realm
#Import
typescript
1import { $realm } from "alepha/api/users";#Overview
Already configured realm for user management.
Realm contains two roles: admin and user.
admin: Has full access to all resources and permissions.user: Has access to their own resources and permissions, but cannot access admin-level resources.
Realm uses session management for handling user sessions.
Environment Variables:
APP_SECRET: Secret key for signing tokens (if not provided in options).
#Options
| Option | Type | Required | Description |
|---|---|---|---|
secret |
string |
No | Secret key for signing tokens |
signing |
SigningConfig |
No | Asymmetric signing config for this realm's tokens (OIDC provider mode) |
issuer |
Partial<IssuerPrimitiveOptions> |
No | Issuer configuration options |
entities |
Object |
No | Override entities. |
settings |
Partial<RealmAuthSettings> |
No | |
isPreAuthorized |
RegistrationPreAuthorizationFn |
No | Let SPECIFIC addresses register while settings.registrationAllowed is false, instead of the realm being open to everyone or to nobody |
bootstrapFirstUser |
boolean |
No | Make the FIRST account created in this realm an administrator, and keep registration reachable until that account exists |
identities |
Object |
No | |
features |
Partial<RealmFeatures> |
No | Enable or disable realm features |