nodejs service BETTERPORTAL v10.1.19

service.betterportal.auth.workos

betterportal/service-betterportal-auth-workos

BetterPortal WorkOS auth service

betterportal auth workos

BetterPortal WorkOS Auth Service

WorkOS AuthKit provider for BetterPortal. The service redirects users to WorkOS, exchanges the callback code server-side with the WorkOS Node SDK, issues BetterPortal tokens, and refreshes BP tokens from the WorkOS refresh token.

Per-app service config requires:

  • clientId
  • apiKey

Optional config:

  • provider defaults to authkit
  • connectionId, organizationId, domainHint
  • scopes
  • loginRedirectPath, logoutRedirectPath
  • roleClaimPath defaults to roles
  • service config workosStatePath defaults to ./workos-state.json; set it to a persistent path such as /data/workos-state.json in production
  • service config syncIntervalSeconds defaults to 21600 and retries stale permission/role sync every 6 hours

Registry org: betterportal.

Role sync keeps BP as the permission source of truth. WorkOS permission slugs are short service-owned keys, bp_<shortId>_<read|create|update|delete>, with the full tenant/service/view mapping stored in workosStatePath. Roles are mirrored per app from WorkOS role slugs into BP app roles.

Installation

Use as a dependency (client reference)
bsb client install betterportal/service-betterportal-auth-workos
Deploy as a service
bsb plugin install betterportal/service-betterportal-auth-workos
Node.js (npm)
npm install @betterportal/auth-workos

Configuration

Configuration options for this plugin:

No configuration required

Available Versions

v10.1.19 v10.1.18 v10.1.17 v10.1.16 v10.1.15 v10.1.11 v10.1.10 v10.1.9 v10.1.8 v10.1.7 v10.1.6 v10.1.5 v10.1.4

Dependencies

No dependencies

Metadata