Skip to content

Package Version

Released
Notes
Source

Select theme

Getting started
- Welcome
- Platform overview
- Architecture
- Quickstart by role
  - Browser app
  - NestJS backend
- App registration
- How it works
  - User registration & login
The CLI (ven)
The playground (auth-client-demo)
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)
auth-server-ts (Node core)
- Overview
- How it works
- Quickstart
- Class reference
auth-server-nest (NestJS adapter)
- Overview
- How it works
- Quickstart
- Class reference

Select theme

On this page

Overview

On this page

Overview

AuthPrincipal

AuthPrincipal

AuthPrincipal = AuthenticatedUser | ServicePrincipal

Defined in: jwt/principals.ts:82

Union of every authenticated principal. Always branch on .kind.

Last updated: Jul 5, 2026

Previous
AppWebhook Next
BASE\_USER