Skip to content
Vendidit Auth
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting started
Welcome
Platform overview
Architecture
Quickstart by role
Browser app
NestJS backend
Laravel backend
App registration
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
auth-shared
interfaces
Interface: AssignablePermission
Interface: AuditLogEntry
Interface: AuditLogQuery
Interface: AuditLogResult
Interface: AuthenticatedUser
Interface: AuthErrorEnvelope
Interface: AuthErrorPayload
Interface: AuthResponse
Interface: BaseJwtClaims
Interface: ChangePasswordRequest
Interface: EmailVerificationClaims
Interface: HardDeleteUserRequest
Interface: ImpersonateRequest
Interface: ImpersonationClaims
Interface: InvitationRecord
Interface: LoginRequest
Interface: LogoutRequest
Interface: LookupUserRecord
Interface: MyOrgRecord
Interface: Organization
Interface: OrgMember
Interface: OrgRole
Interface: PasswordResetClaims
Interface: PermissionManifestEntry
Interface: RefreshJwtPayload
Interface: RefreshRequest
Interface: RegisterRequest
Interface: RequestPasswordResetRequest
Interface: ResendVerificationEmailRequest
Interface: ResetPasswordRequest
Interface: ServiceJwtPayload
Interface: ServicePrincipal
Interface: ServiceTokenResponse
Interface: SessionRecord
Interface: SsoCallbackRequest
Interface: SsoExchangeRequest
Interface: SsoProviderInfo
Interface: SsoUrlRequest
Interface: SsoUrlResponse
Interface: TokenPair
Interface: TwoFactorDisableRequest
Interface: TwoFactorEnableRequest
Interface: TwoFactorSetupResponse
Interface: User
Interface: UserJwtPayload
Interface: ValidateTokenRequest
Interface: ValidateTokenResponse
Interface: VerifyEmailRequest
type-aliases
Type Alias: AccessJwtPayload
Type Alias: AuthErrorCode
Type Alias: AuthPrincipal
Type Alias: JwtPayload
Type Alias: SystemRoleCode
Type Alias: TokenType
variables
Variable: ACCOUNT\_LOCKED
Variable: BASE\_USER
Variable: BUYER
Variable: CONFLICT
Variable: FORBIDDEN
Variable: INVALID\_CLIENT
Variable: INVALID\_CREDENTIALS
Variable: INVALID\_GRANT
Variable: INVALID\_SCOPE
Variable: NOT\_FOUND
Variable: ORG\_ADMIN
Variable: ORG\_MANAGER
Variable: ORG\_MEMBER
Variable: RATE\_LIMITED
Variable: REQUIRES\_2FA
Variable: SELLER
Variable: SERVER\_ERROR
Variable: SUPER\_ADMIN
Variable: SYSTEM\_ADMIN
Variable: TOKEN\_EXPIRED
Variable: TOKEN\_INVALID
Variable: TOKEN\_REVOKED
Variable: TOKEN\_TYPE\_ACCESS
Variable: TOKEN\_TYPE\_REFRESH
Variable: TOKEN\_TYPE\_SERVICE
Variable: UNAUTHORIZED
Variable: UNSUPPORTED\_GRANT\_TYPE
Variable: VALIDATION
auth-client (TS browser SDK)
Overview
How it works
Quickstart
Framework adapters
React
Preact
Solid
Vue
Astro
Class reference
auth-client
classes
Class: AdminFlow
Class: AuthClient
Class: AuthError
Class: BroadcastChannelAdapter
Class: ConflictError
Class: ConsoleLogger
Class: EventEmitter
Class: FetchTransport
Class: FixedClock
Class: ForbiddenError
Class: ImpersonationFlow
Class: InvalidTokenError
Class: LocalStorageStorage
Class: LocalStorageTokenStore
Class: LoginFlow
Class: LogoutFlow
Class: MemoryStorage
Class: MemoryTokenStore
Class: NetworkError
Class: NoOpBroadcast
Class: NoOpLogger
Class: NotFoundError
Class: OfflineModeError
Class: RateLimitedError
Class: RefreshFlow
Class: RefreshMutex\<T\>
Class: RegistrationFlow
Class: RequiresTwoFactorError
Class: ServerError
Class: SsoFlow
Class: SystemClock
Class: TotpFlow
Class: UnauthenticatedError
Class: ValidationError
Class: WebCryptoAdapter
functions
Function: createAuthClient()
Function: createDefaultBroadcast()
Function: decodeAccessToken()
Function: deriveS256Challenge()
Function: fromHttpResponse()
Function: generatePKCEPair()
Function: runOptimisticAction()
Function: secondsUntilExpiry()
Function: tryDecodeAccessToken()
interfaces
Interface: AssignablePermissionRecord
Interface: AuditLogEntry
Interface: AuditLogQuery
Interface: AuditLogResult
Interface: AuthClientConfig
Interface: AuthClientPorts
Interface: AuthResponse
Interface: AuthSnapshot
Interface: Broadcast
Interface: BroadcastMessage
Interface: Clock
Interface: CreateInvitationRequest
Interface: CreateOrgRequest
Interface: CreateOrgRoleRequest
Interface: Crypto
Interface: DecodedAccessToken
Interface: FetchTransportOptions
Interface: FlowDeps
Interface: HardDeleteUserRequest
Interface: ImpersonateParams
Interface: ImpersonateRequest
Interface: InvitationRecord
Interface: Logger
Interface: LoginParams
Interface: LoginRequest
Interface: LogoutRequest
Interface: LookupUserRecord
Interface: LookupUsersRequest
Interface: MagicLinkRequest
Interface: MagicLinkVerifyRequest
Interface: MyOrgRecord
Interface: Organization
Interface: OrgMemberRecord
Interface: OrgRoleRecord
Interface: PKCEPair
Interface: RefreshRequest
Interface: RegisterParams
Interface: RegisterRequest
Interface: RetryOptions
Interface: SessionRecord
Interface: SsoCompleteRequest
Interface: SsoStartParams
Interface: SsoStartRequest
Interface: SsoStartResult
Interface: Storage
Interface: StoredTokens
Interface: TokenPair
Interface: TokenStore
Interface: TotpDisableRequest
Interface: Transport
Interface: TransportRequest
Interface: TransportResponse\<T\>
Interface: UpdateMemberStatusRequest
Interface: UpdateOrgRequest
Interface: UpdateOrgRoleRequest
Interface: User
type-aliases
Type Alias: AuthEvent
Type Alias: AuthEventHandler\<T\>
Type Alias: AuthEventType
Type Alias: AuthStatus
Type Alias: LogoutReason
variables
Variable: DEFAULTS
auth-server-ts (Node core)
Overview
How it works
Quickstart
Class reference
auth-server-ts
classes
Class: AuthClient
Class: AuthHttpClient
Class: ConflictException
Class: ErrorMapper
Class: FixedClock
Class: Flows
Class: ForbiddenException
Class: HttpTransport
Class: InMemoryRevocationCache
Class: InMemorySessionStore
Class: InMemoryTransport
Class: InvalidCredentialsException
Class: JwtValidator
Class: NetworkException
Class: NotFoundException
Class: NullRevocationCache
Class: OfflineModeException
Class: PermissionRegistrar
Class: RateLimitedException
Class: ServerException
Class: ServiceAuthClient
Class: SystemClock
Class: TokenExpiredException
Class: TokenInvalidException
Class: TokenRevokedException
Class: TokenValidationError
Class: TokenValidator
Class: TwoFactorRequiredException
Class: UnauthorizedException
Class: ValidationException
Class: VenAuthException
functions
Function: apiUrl()
Function: endpointUrl()
Function: resolveConfig()
interfaces
Interface: AssignablePermission
Interface: AuditLogEntry
Interface: AuditLogQuery
Interface: AuditLogResult
Interface: AuthClientDependencies
Interface: AuthClientOptions
Interface: AuthenticatedUser
Interface: AuthErrorEnvelope
Interface: AuthErrorPayload
Interface: AuthHttpClientOptions
Interface: AuthResponse
Interface: BaseJwtClaims
Interface: ChangePasswordRequest
Interface: Clock
Interface: EmailVerificationClaims
Interface: HardDeleteUserRequest
Interface: HttpRequestConfig
Interface: HttpResponse\<T\>
Interface: HttpTransportContract
Interface: HttpTransportFetchOptions
Interface: HttpTransportPort
Interface: ImpersonateRequest
Interface: ImpersonationClaims
Interface: InvitationRecord
Interface: JwtValidatorOptions
Interface: LoggerPort
Interface: LoginRequest
Interface: LogoutRequest
Interface: LookupUserRecord
Interface: M2MCredentials
Interface: MyOrgRecord
Interface: Organization
Interface: OrgMember
Interface: OrgRole
Interface: PasswordResetClaims
Interface: PermissionManifestEntry
Interface: PermissionRegistrarOptions
Interface: RefreshJwtPayload
Interface: RefreshRequest
Interface: RegisterRequest
Interface: RequestPasswordResetRequest
Interface: ResendVerificationEmailRequest
Interface: ResetPasswordRequest
Interface: ResolvedConfig
Interface: RevocationCache
Interface: ServiceAuthClientOptions
Interface: ServiceJwtPayload
Interface: ServicePrincipal
Interface: ServiceTokenResponse
Interface: SessionRecord
Interface: SessionStore
Interface: SsoCallbackRequest
Interface: SsoExchangeRequest
Interface: SsoProviderInfo
Interface: SsoUrlRequest
Interface: SsoUrlResponse
Interface: TokenCachePort
Interface: TokenPair
Interface: TokenValidatorContract
Interface: TokenValidatorOptions
Interface: TwoFactorDisableRequest
Interface: TwoFactorEnableRequest
Interface: TwoFactorSetupResponse
Interface: User
Interface: UserJwtPayload
Interface: ValidateTokenRequest
Interface: ValidateTokenResponse
Interface: VerifyEmailRequest
type-aliases
Type Alias: AccessJwtPayload
Type Alias: AuthErrorCode
Type Alias: AuthPrincipal
Type Alias: JwtPayload
variables
Variable: Defaults
Variable: NoOpLogger
auth-server-nest (NestJS adapter)
Overview
How it works
Quickstart
Class reference
auth-server-nest
classes
Class: AuthClientModule
Class: AuthHttpClient
Class: AxiosHttpTransportAdapter
Class: JwtAuthGuard
Class: PermissionRegistrarService
Class: PermissionsGuard
Class: RedisTokenCacheAdapter
Class: RolesGuard
Class: ServiceAuthClient
Class: ServiceOnlyGuard
Class: TokenValidatorService
functions
Function: Permissions()
Function: Public()
Function: Roles()
Function: ServiceOnly()
interfaces
Interface: AuthClientOptions
Interface: AuthenticatedRequest
Interface: AuthenticatedUser
Interface: LookupUserRecord
Interface: MyOrgRecord
Interface: PermissionManifestEntry
Interface: RefreshJwtPayload
Interface: ServiceJwtPayload
Interface: ServicePrincipal
Interface: UserJwtPayload
type-aliases
Type Alias: AuthClientRedis
Type Alias: AuthPrincipal
Type Alias: JwtPayload
variables
Variable: AUTH\_CLIENT\_OPTIONS
Variable: AUTH\_CLIENT\_REDIS
Variable: CurrentUser
auth-server-php (PHP core)
Overview
How it works
Quickstart
Class reference
Class reference
AuthClient
AuthResponse
Config
Defaults
ErrorMapper
FixedClock
Flows
HttpTransport
InMemoryRevocationCache
InMemorySessionStore
InMemoryTransport
JwtValidator
NullRevocationCache
OfflineModeException
Principal
PsrSimpleCacheRevocationCache
RevocationCache
ServicePrincipal
SessionStore
TokenPair
Transport
TwoFactorRequiredException
UserPrincipal
VenAuthException
auth-server-laravel (Laravel adapter)
Overview
How it works
Quickstart
Class reference
Class reference
Authenticate
HasVenAuth
LaravelCacheBridge
RefuseUnderImpersonation
RequireApp
RequireOrgContext
RequirePermission
RequireRole
ResponseHelpers
VenAuth
VenAuthServiceProvider
VenAuthUser
VenJwtGuard
VenUserProvider
Design docs (historical)
TS packages design
PHP + Laravel design
GitHub
Select theme
Dark
Light
Auto
Variable: CONFLICT
Variable: CONFLICT
const
CONFLICT
:
"CONFLICT"
=
'CONFLICT'
Defined in: errors/codes.ts:30
