Skip to content
rw3iss Auth
Package
All packages
auth-server
auth-shared
auth-client
auth-client-demo
auth-server-ts
auth-server-nest
auth-server-php
auth-server-laravel
Version
×
Released
Notes
Source
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting started
Welcome
Platform overview
Architecture
Quickstart by role
Browser app
NestJS backend
App registration
How it works
User registration & login
The CLI (ven)
Overview
Commands
Scripting
The playground (auth-client-demo)
Overview
How to use it
Component catalog
auth-server (Go)
Overview
How it works
API endpoints
Operations
App registration
Development
auth-shared (TS types)
Overview
Type reference
Overview
Core wire types
AuthenticatedUser
I
AuthResponse
I
LoginRequest
I
RefreshRequest
I
RegisterRequest
I
User
I
ValidateTokenRequest
I
ValidateTokenResponse
I
JWT claims & tokens
AccessJwtPayload
T
BaseJwtClaims
I
JwtPayload
T
RefreshJwtPayload
I
ServiceJwtPayload
I
ServicePrincipal
I
ServiceTokenResponse
I
TokenPair
I
UserJwtPayload
I
Sessions
LogoutRequest
I
SessionRecord
I
Password lifecycle
ChangePasswordRequest
I
RequestPasswordResetRequest
I
ResetPasswordRequest
I
Two-factor & email verification
EmailVerificationClaims
I
ResendVerificationEmailRequest
I
TwoFactorDisableRequest
I
TwoFactorEnableRequest
I
TwoFactorSetupResponse
I
VerifyEmailRequest
I
SSO & magic link
SsoCallbackRequest
I
SsoExchangeRequest
I
SsoProviderInfo
I
SsoUrlRequest
I
SsoUrlResponse
I
Organizations
AdminUserOrgMembership
I
CreateInvitationRequest
I
CreateOrgRequest
I
CreateOrgRoleRequest
I
InvitationRecord
I
MyOrgRecord
I
Organization
I
OrgMember
I
OrgMemberRecord
I
OrgRole
I
OrgRoleRecord
I
UpdateMemberStatusRequest
I
UpdateOrgRequest
I
UpdateOrgRoleRequest
I
Admin & impersonation
AssignablePermission
I
AssignablePermissionRecord
I
HardDeleteUserRequest
I
ImpersonateRequest
I
ImpersonationClaims
I
LookupUserRecord
I
Audit log
AuditLogEntry
I
AuditLogQuery
I
AuditLogResult
I
Error envelopes
AuthErrorCode
T
AuthErrorEnvelope
I
AuthErrorPayload
I
Permissions & policies
PermissionManifestEntry
I
RegistrationPolicy
I
Constants & misc
ACCOUNT\_LOCKED
V
APP\_WEBHOOK\_EVENTS
V
AppRecord
I
AppWebhook
I
AuthPrincipal
T
BASE\_USER
V
BUYER
V
CONFLICT
V
CreateAppRequest
I
CreateM2MClientRequest
I
CreateM2MClientResponse
I
FORBIDDEN
V
INVALID\_CLIENT
V
INVALID\_CREDENTIALS
V
INVALID\_GRANT
V
INVALID\_SCOPE
V
KNOWN\_BASE\_ROLE\_LABELS
V
ListNamespacesResponse
I
M2MClientRecord
I
NamespaceInfo
I
NOT\_FOUND
V
ORG\_ADMIN
V
ORG\_MANAGER
V
ORG\_MEMBER
V
PasswordResetClaims
I
RATE\_LIMITED
V
REQUIRES\_2FA
V
roleLabel
ƒ
RoleLabelOptions
I
roleLabels
ƒ
RoleLike
I
SELLER
V
SERVER\_ERROR
V
SUPER\_ADMIN
V
SYSTEM\_ADMIN
V
SystemRoleCode
T
TOKEN\_EXPIRED
V
TOKEN\_INVALID
V
TOKEN\_REVOKED
V
TOKEN\_TYPE\_ACCESS
V
TOKEN\_TYPE\_REFRESH
V
TOKEN\_TYPE\_SERVICE
V
TokenType
T
UNAUTHORIZED
V
UNSUPPORTED\_GRANT\_TYPE
V
UpdateAppRequest
I
UserNamespacesResponse
I
UserRoleSummary
I
VALIDATION
V
auth-client (TS browser SDK)
Overview
How it works
Quickstart
Example usage
Login & Registration
Applications
Services (m2m)
Users
Organizations
Framework adapters
React
Preact
Solid
Vue
Astro
UI components
Overview
Atoms
Atoms
AuthLoading
A
AuthStatusBadge
A
GuestOnly
A
LogoutAllButton
A
LogoutButton
A
PasswordStrengthMeter
A
PermissionGate
A
ProtectedRoute
A
RoleGate
A
SsoButton
A
SsoButtonGroup
A
TokenExpiryCountdown
A
UserAvatar
A
UserMenu
A
Forms & views
Forms & views
AdminUserEditPanel
F
AuditLogTable
F
ChangePasswordForm
F
DeleteAccountForm
F
EmailVerificationNotice
F
InvitationAcceptCard
F
InvitationsAdminList
F
InvitationsList
F
InviteMemberForm
F
LoginForm
F
MagicLinkRequestForm
F
MembersList
F
OrgCreateForm
F
OrgRoleEditor
F
OrgSettingsForm
F
OrgSwitcher
F
PasswordResetForm
F
PasswordResetRequestForm
F
RegisterForm
F
SessionsList
F
TwoFactorDisableForm
F
TwoFactorEnrollment
F
UserLookupTable
F
UserProfileCard
F
UsersTable
F
Flows
Flows
CompleteAccountSecurityFlow
L
CompleteEmailVerificationFlow
L
CompleteImpersonationFlow
L
CompleteLoginFlow
L
CompleteOrgAdminFlow
L
CompletePasswordResetFlow
L
CompleteSignupFlow
L
CompleteSsoCallbackFlow
L
Class reference
Overview
Core SDK
AuthClient
C
AuthClientConfig
I
AuthClientPorts
I
AuthEvent
T
AuthEventHandler
T
AuthEventType
T
AuthResponse
I
AuthSnapshot
I
AuthStatus
T
createAuthClient
ƒ
DEFAULTS
V
EventEmitter
C
FlowDeps
I
LoginParams
I
RefreshMutex
C
RegisterParams
I
runOptimisticAction
ƒ
User
I
Modules
AccountModule
C
AppsModule
C
AuditModule
C
AuthModule
C
OrganizationsModule
C
PoolsModule
C
ServicesModule
C
SessionsModule
C
UsersModule
C
Flows
AdminFlow
C
AppsFlow
C
ImpersonationFlow
C
LoginFlow
C
LogoutFlow
C
M2MFlow
C
RefreshFlow
C
RegistrationFlow
C
SsoFlow
C
TotpFlow
C
Transport & ports
Broadcast
I
BroadcastChannelAdapter
C
BroadcastMessage
I
Clock
I
ConsoleLogger
C
createDefaultBroadcast
ƒ
Crypto
I
FetchTransport
C
FetchTransportOptions
I
FixedClock
C
LocalStorageStorage
C
LocalStorageTokenStore
C
Logger
I
MemoryStorage
C
MemoryTokenStore
C
NoOpBroadcast
C
NoOpLogger
C
RetryOptions
I
Storage
I
SystemClock
C
TokenStore
I
Transport
I
TransportRequest
I
TransportResponse
I
WebCryptoAdapter
C
Errors
AuthError
C
ConflictError
C
ForbiddenError
C
fromHttpResponse
ƒ
InvalidTokenError
C
NetworkError
C
NotFoundError
C
OfflineModeError
C
RateLimitedError
C
RequiresTwoFactorError
C
ServerError
C
UnauthenticatedError
C
ValidationError
C
Tokens & PKCE
decodeAccessToken
ƒ
DecodedAccessToken
I
deriveS256Challenge
ƒ
generatePKCEPair
ƒ
PKCEPair
I
secondsUntilExpiry
ƒ
StoredTokens
I
TokenPair
I
tryDecodeAccessToken
ƒ
Organizations & memberships
AdminUserOrgMembership
I
CreateInvitationRequest
I
CreateOrgRequest
I
CreateOrgRoleRequest
I
InvitationRecord
I
MyOrgRecord
I
Organization
I
OrgMemberRecord
I
OrgRoleRecord
I
UpdateMemberStatusRequest
I
UpdateOrgRequest
I
UpdateOrgRoleRequest
I
Applications & webhooks
APP\_WEBHOOK\_EVENTS
V
AppRecord
I
AppWebhook
I
CreateAppRequest
I
UpdateAppRequest
I
User pools
ListNamespacesResponse
I
NamespaceInfo
I
NamespacesFlow
C
UserNamespacesResponse
I
Services (m2m)
CreateM2MClientRequest
I
CreateM2MClientResponse
I
M2MClientRecord
I
Admin & impersonation
AssignablePermissionRecord
I
HardDeleteUserRequest
I
ImpersonateParams
I
ImpersonateRequest
I
LookupUserRecord
I
LookupUsersRequest
I
Audit log
AuditLogEntry
I
AuditLogQuery
I
AuditLogResult
I
SSO & magic link
MagicLinkRequest
I
MagicLinkVerifyRequest
I
SsoCompleteRequest
I
SsoStartParams
I
SsoStartRequest
I
SsoStartResult
I
Two-factor (TOTP)
TotpDisableRequest
I
Domain models
LoginRequest
I
LogoutReason
T
LogoutRequest
I
RefreshRequest
I
RegisterRequest
I
SessionRecord
I
Roles & JWT claims
AccessJwtPayload
T
AuthenticatedUser
I
AuthPrincipal
T
BASE\_USER
V
BaseJwtClaims
I
BUYER
V
EmailVerificationClaims
I
ImpersonationClaims
I
JwtPayloadUnion
T
KNOWN\_BASE\_ROLE\_LABELS
V
ORG\_ADMIN
V
ORG\_MANAGER
V
ORG\_MEMBER
V
PasswordResetClaims
I
RefreshJwtPayload
I
roleLabel
ƒ
RoleLabelOptions
I
roleLabels
ƒ
RoleLike
I
SELLER
V
ServiceJwtPayload
I
ServicePrincipal
I
SUPER\_ADMIN
V
SYSTEM\_ADMIN
V
SystemRoleCode
T
UserJwtPayload
I
Misc utilities
ClientFlows
I
CoreAuth
T
ModuleContext
I
auth-server-ts (Node core)
Overview
How it works
Quickstart
Class reference
Overview
Core facade
AuthClient
C
AuthClientDependencies
I
AuthClientOptions
I
Flows
C
Transport & ports
AuthHttpClientOptions
I
Clock
I
FixedClock
C
HttpTransport
C
HttpTransportContract
I
HttpTransportFetchOptions
I
InMemoryRevocationCache
C
InMemorySessionStore
C
InMemoryTransport
C
LoggerPort
I
NoOpLogger
V
NullRevocationCache
C
SystemClock
C
Tokens & validation
~~TokenValidator~~
AccessJwtPayload
T
BaseJwtClaims
I
JwtPayload
T
JwtValidator
C
JwtValidatorOptions
I
RefreshJwtPayload
I
ServiceJwtPayload
I
ServicePrincipal
I
ServiceTokenResponse
I
TokenPair
I
TokenValidatorContract
I
TokenValidatorOptions
I
UserJwtPayload
I
Permissions & registration
~~PermissionRegistrar~~
PermissionManifestEntry
I
PermissionRegistrarOptions
I
Exception hierarchy
AuthErrorCode
T
AuthErrorEnvelope
I
AuthErrorPayload
I
ConflictException
C
ErrorMapper
C
ForbiddenException
C
InvalidCredentialsException
C
NetworkException
C
NotFoundException
C
OfflineModeException
C
RateLimitedException
C
ServerException
C
TokenExpiredException
C
TokenInvalidException
C
TokenRevokedException
C
TokenValidationError
C
TwoFactorRequiredException
C
UnauthorizedException
C
ValidationException
C
VenAuthException
C
Sessions
SessionRecord
I
SessionStore
I
Organizations
InvitationRecord
I
MyOrgRecord
I
Organization
I
OrgMember
I
OrgRole
I
Admin & impersonation
AssignablePermission
I
HardDeleteUserRequest
I
ImpersonateRequest
I
ImpersonationClaims
I
LookupUserRecord
I
Audit log
AuditLogEntry
I
AuditLogQuery
I
AuditLogResult
I
Password lifecycle
ChangePasswordRequest
I
RequestPasswordResetRequest
I
ResetPasswordRequest
I
Two-factor & email
EmailVerificationClaims
I
ResendVerificationEmailRequest
I
TwoFactorDisableRequest
I
TwoFactorEnableRequest
I
TwoFactorSetupResponse
I
VerifyEmailRequest
I
SSO & magic link
SsoCallbackRequest
I
SsoExchangeRequest
I
SsoProviderInfo
I
SsoUrlRequest
I
SsoUrlResponse
I
Misc
~~AuthHttpClient~~
~~HttpTransportPort~~
~~ServiceAuthClient~~
~~TokenCachePort~~
apiUrl
ƒ
AuthenticatedUser
I
AuthPrincipal
T
AuthResponse
I
Defaults
V
endpointUrl
ƒ
HttpRequestConfig
I
HttpResponse
I
LoginRequest
I
LogoutRequest
I
M2MCredentials
I
PasswordResetClaims
I
RefreshRequest
I
RegisterRequest
I
resolveConfig
ƒ
ResolvedConfig
I
RevocationCache
I
ServiceAuthClientOptions
I
User
I
ValidateTokenRequest
I
ValidateTokenResponse
I
auth-server-nest (NestJS adapter)
Overview
How it works
Quickstart
Class reference
Overview
Module & DI
AuthClientModule
C
Guards
JwtAuthGuard
C
PermissionsGuard
C
RolesGuard
C
ServiceOnlyGuard
C
Services
AuthHttpClient
C
PermissionRegistrarService
C
ServiceAuthClient
C
TokenValidatorService
C
Adapters
AxiosHttpTransportAdapter
C
RedisTokenCacheAdapter
C
Config & misc
AUTH\_CLIENT\_OPTIONS
V
AUTH\_CLIENT\_REDIS
V
AuthClientOptions
I
AuthClientRedis
T
AuthenticatedRequest
I
AuthenticatedUser
I
AuthPrincipal
T
CurrentUser
V
JwtPayload
T
LookupUserRecord
I
MyOrgRecord
I
PermissionManifestEntry
I
Permissions
ƒ
Public
ƒ
RefreshJwtPayload
I
Roles
ƒ
ServiceJwtPayload
I
ServiceOnly
ƒ
ServicePrincipal
I
UserJwtPayload
I
GitHub
Select theme
Dark
Light
Auto
AuthEventType
AuthEventType
AuthEventType
=
AuthEvent
[
"type"
]
Defined in:
auth-client/src/core/types.ts:326