alepha@docs:~/docs/reference/primitives$
cat $realm.md1 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 |
issuer |
Partial<IssuerPrimitiveOptions> |
No | Issuer configuration options |
entities |
Object |
No | Override entities. |
users |
Repository<typeof users.schema> |
No | |
identities |
Repository<typeof identities.schema> |
No | |
sessions |
Repository<typeof sessions.schema> |
No | |
settings |
Partial<RealmAuthSettings> |
No | |
identities |
Object |
No | |
credentials |
true |
No | |
google |
true |
No | |
github |
true |
No | |
features |
Partial<RealmFeatures> |
No | Enable or disable realm features |