Skip to content

auth

Generated Reference

Authentication, authorization, roles, sessions, governance, and onboarding flows re-exported by the root runtime. This page is generated from core/auth/index.ts against package version 0.8.3 on the 0.8 docs line.

Import

ts
import { createAuthSystem, authenticateWithPassword, requestPasswordReset } from '@system-core/core'

Entry

FieldValue
Import path@system-core/core
Package export.
Source entrycore/auth/index.ts
Exported symbols83
Runtime file./dist/index.js
Types file./dist/index.d.ts

Use This Surface When

  • Use the root package when application code needs package-owned auth helpers or policies.
  • Treat these exports as part of the root runtime contract instead of rebuilding auth primitives.
  • Reach for this surface when wiring RBAC, sessions, or tenant-aware auth behaviors.

Public Surface

Functions

ExportKindSource
acceptInvitefunctioncore/auth/onboarding.ts
addRolePermissionsfunctioncore/auth/roles.ts
assignUserRolefunctioncore/auth/users.ts
authenticateWithMagicLinkfunctioncore/auth/authentication.ts
authenticateWithPasswordfunctioncore/auth/authentication.ts
checkBulkPermissionsfunctioncore/auth/authorization.ts
createAuthSystemfunctioncore/auth/system.ts
createPermissionfunctioncore/auth/permissions.ts
createRolefunctioncore/auth/roles.ts
createSessionForUserfunctioncore/auth/sessions.ts
createUserfunctioncore/auth/users.ts
deactivateUserfunctioncore/auth/users.ts
deletePermissionfunctioncore/auth/permissions.ts
deleteRolefunctioncore/auth/roles.ts
deleteUserfunctioncore/auth/users.ts
getBootstrapStatusfunctioncore/auth/bootstrap.ts
getDefaultRoleLevelfunctioncore/auth/meta.ts
getEffectivePermissionsfunctioncore/auth/authorization.ts
getEffectiveRolesfunctioncore/auth/authorization.ts
getRolePermissionsfunctioncore/auth/roles.ts
getUserByIdfunctioncore/auth/users.ts
hasEffectivePermissionfunctioncore/auth/authorization.ts
hasRoleLevelfunctioncore/auth/authorization.ts
inviteUserfunctioncore/auth/onboarding.ts
listPermissionsfunctioncore/auth/permissions.ts
listRolesfunctioncore/auth/roles.ts
listUserPermissionOverridesfunctioncore/auth/permissions.ts
listUserRolesfunctioncore/auth/users.ts
listUsersfunctioncore/auth/users.ts
listUserSessionsfunctioncore/auth/sessions.ts
logoutfunctioncore/auth/sessions.ts
logoutAllSessionsfunctioncore/auth/sessions.ts
matchesPermissionfunctioncore/auth/authorization.ts
reactivateUserfunctioncore/auth/users.ts
refreshSessionfunctioncore/auth/sessions.ts
registerInitialSuperAdminfunctioncore/auth/bootstrap.ts
requestEmailVerificationfunctioncore/auth/onboarding.ts
requestMagicLinkfunctioncore/auth/authentication.ts
requestPasswordResetfunctioncore/auth/onboarding.ts
requirePermissionForUserfunctioncore/auth/authorization.ts
resetPasswordfunctioncore/auth/onboarding.ts
resolveAuthGovernancefunctioncore/auth/config.ts
resolveAuthPolicyfunctioncore/auth/policy.ts
resolveRoleLevelfunctioncore/auth/governance.ts
revokeExpiredSessionsfunctioncore/auth/sessions.ts
revokeRolePermissionsfunctioncore/auth/roles.ts
revokeSessionfunctioncore/auth/sessions.ts
setRolePermissionsfunctioncore/auth/roles.ts
setUserPermissionOverridesfunctioncore/auth/permissions.ts
unassignUserRolefunctioncore/auth/users.ts
updatePermissionfunctioncore/auth/permissions.ts
updateRolefunctioncore/auth/roles.ts
updateUserfunctioncore/auth/users.ts
verifyEmailfunctioncore/auth/onboarding.ts

Consts

ExportKindSource
DEFAULT_AUTH_GOVERNANCEconstcore/auth/config.ts
DEFAULT_AUTH_POLICYconstcore/auth/policy.ts
DEFAULT_PERMISSION_METAconstcore/auth/meta.ts
DEFAULT_ROLE_DEFINITIONSconstcore/auth/meta.ts
DEFAULT_ROLE_HIERARCHYconstcore/auth/meta.ts

Interfaces

ExportKindSource
AuthContextinterfacecore/auth/deps.ts
AuthDepsinterfacecore/auth/deps.ts
AuthenticateWithMagicLinkInputinterfacecore/auth/authentication.ts
AuthenticateWithPasswordInputinterfacecore/auth/authentication.ts
AuthenticationResultinterfacecore/auth/authentication.ts
AuthGovernanceConfiginterfacecore/auth/deps.ts
AuthPolicyConfiginterfacecore/auth/policy.ts
AuthSysteminterfacecore/auth/system.ts
EmailVerificationRecordinterfacecore/auth/types.ts
InviteRecordinterfacecore/auth/types.ts
MagicLinkRecordinterfacecore/auth/types.ts
PasswordResetRecordinterfacecore/auth/types.ts
PermissionRecordinterfacecore/auth/types.ts
RequestMagicLinkInputinterfacecore/auth/authentication.ts
RolePermissionAssignmentinterfacecore/auth/types.ts
RoleRecordinterfacecore/auth/types.ts
SessionRecordinterfacecore/auth/types.ts
SessionTokensinterfacecore/auth/sessions.ts
UserPermissionOverrideinterfacecore/auth/types.ts
UserRecordinterfacecore/auth/types.ts
UserRoleAssignmentinterfacecore/auth/types.ts

Types

ExportKindSource
AuthRuntimeContexttypecore/auth/policy.ts
PermissionEffecttypecore/auth/types.ts
UserStatustypecore/auth/types.ts

system-core documentation for maintainers, integrators, and AI build agents.