Snapshot for @system-core/core 0.8.x. Current docs live at /.

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.1 on the 0.8 docs line.

Import

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

Entry

Field	Value
Import path	@system-core/core
Package export	.
Source entry	core/auth/index.ts
Exported symbols	83
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

Export	Kind	Source
acceptInvite	function	core/auth/onboarding.ts
addRolePermissions	function	core/auth/roles.ts
assignUserRole	function	core/auth/users.ts
authenticateWithMagicLink	function	core/auth/authentication.ts
authenticateWithPassword	function	core/auth/authentication.ts
checkBulkPermissions	function	core/auth/authorization.ts
createAuthSystem	function	core/auth/system.ts
createPermission	function	core/auth/permissions.ts
createRole	function	core/auth/roles.ts
createSessionForUser	function	core/auth/sessions.ts
createUser	function	core/auth/users.ts
deactivateUser	function	core/auth/users.ts
deletePermission	function	core/auth/permissions.ts
deleteRole	function	core/auth/roles.ts
deleteUser	function	core/auth/users.ts
getBootstrapStatus	function	core/auth/bootstrap.ts
getDefaultRoleLevel	function	core/auth/meta.ts
getEffectivePermissions	function	core/auth/authorization.ts
getEffectiveRoles	function	core/auth/authorization.ts
getRolePermissions	function	core/auth/roles.ts
getUserById	function	core/auth/users.ts
hasEffectivePermission	function	core/auth/authorization.ts
hasRoleLevel	function	core/auth/authorization.ts
inviteUser	function	core/auth/onboarding.ts
listPermissions	function	core/auth/permissions.ts
listRoles	function	core/auth/roles.ts
listUserPermissionOverrides	function	core/auth/permissions.ts
listUserRoles	function	core/auth/users.ts
listUsers	function	core/auth/users.ts
listUserSessions	function	core/auth/sessions.ts
logout	function	core/auth/sessions.ts
logoutAllSessions	function	core/auth/sessions.ts
matchesPermission	function	core/auth/authorization.ts
reactivateUser	function	core/auth/users.ts
refreshSession	function	core/auth/sessions.ts
registerInitialSuperAdmin	function	core/auth/bootstrap.ts
requestEmailVerification	function	core/auth/onboarding.ts
requestMagicLink	function	core/auth/authentication.ts
requestPasswordReset	function	core/auth/onboarding.ts
requirePermissionForUser	function	core/auth/authorization.ts
resetPassword	function	core/auth/onboarding.ts
resolveAuthGovernance	function	core/auth/config.ts
resolveAuthPolicy	function	core/auth/policy.ts
resolveRoleLevel	function	core/auth/governance.ts
revokeExpiredSessions	function	core/auth/sessions.ts
revokeRolePermissions	function	core/auth/roles.ts
revokeSession	function	core/auth/sessions.ts
setRolePermissions	function	core/auth/roles.ts
setUserPermissionOverrides	function	core/auth/permissions.ts
unassignUserRole	function	core/auth/users.ts
updatePermission	function	core/auth/permissions.ts
updateRole	function	core/auth/roles.ts
updateUser	function	core/auth/users.ts
verifyEmail	function	core/auth/onboarding.ts

Consts

Export	Kind	Source
DEFAULT_AUTH_GOVERNANCE	const	core/auth/config.ts
DEFAULT_AUTH_POLICY	const	core/auth/policy.ts
DEFAULT_PERMISSION_META	const	core/auth/meta.ts
DEFAULT_ROLE_DEFINITIONS	const	core/auth/meta.ts
DEFAULT_ROLE_HIERARCHY	const	core/auth/meta.ts

Interfaces

Export	Kind	Source
AuthContext	interface	core/auth/deps.ts
AuthDeps	interface	core/auth/deps.ts
AuthenticateWithMagicLinkInput	interface	core/auth/authentication.ts
AuthenticateWithPasswordInput	interface	core/auth/authentication.ts
AuthenticationResult	interface	core/auth/authentication.ts
AuthGovernanceConfig	interface	core/auth/deps.ts
AuthPolicyConfig	interface	core/auth/policy.ts
AuthSystem	interface	core/auth/system.ts
EmailVerificationRecord	interface	core/auth/types.ts
InviteRecord	interface	core/auth/types.ts
MagicLinkRecord	interface	core/auth/types.ts
PasswordResetRecord	interface	core/auth/types.ts
PermissionRecord	interface	core/auth/types.ts
RequestMagicLinkInput	interface	core/auth/authentication.ts
RolePermissionAssignment	interface	core/auth/types.ts
RoleRecord	interface	core/auth/types.ts
SessionRecord	interface	core/auth/types.ts
SessionTokens	interface	core/auth/sessions.ts
UserPermissionOverride	interface	core/auth/types.ts
UserRecord	interface	core/auth/types.ts
UserRoleAssignment	interface	core/auth/types.ts

Types

Export	Kind	Source
AuthRuntimeContext	type	core/auth/policy.ts
PermissionEffect	type	core/auth/types.ts
UserStatus	type	core/auth/types.ts

Related

• core
• Do This, Not That
• Auth RBAC 0.3.0