Skip to content

Integrate with LXS ​

Engineers use these guides to connect a product to LXS Directory (authentication, sessions, tenant APIs) and optionally the LXS-hosted front-end. Pick an integration path first, then follow the shared runbooks for front-end shape, auth, sessions, and OAuth/OIDC.

Hosted documentation ​

EnvironmentBase URL
Developmenthttps://docs.dev.us.lxs.lxp.live
QAhttps://docs.qa.us.lxs.lxp.live
Productionhttps://docs.prod.us.lxs.lxp.live

Tenant vanity hosts (for apps and APIs) follow your deploy’s CLIENT_VANITY_DOMAIN_BASE pattern, for example https://{tenantSlug}.mm.dev.lxs.lxp.live.

Two integration paths ​

Path A — First-Party SessionPath B — OAuth Connected Application
Who owns the browser sessionLXS (HttpOnly session cookie on the LXS site)Your application (you issue and store your own session after OIDC)
How the user signs inSame login flows as LXS (local, SAML, tenant OAuth, managed Microsoft/Google, etc.)LXS acts as an OpenID Provider; your app is the OAuth client
API authorizationBrowser sends the LXS session cookie (credentials: 'include') plus deploy headersYour backend calls LXS with a Bearer access token from the token endpoint (LXS session token)
Best whenYour UI and APIs share the LXS vanity domain (or you proxy so cookies are first-party)You run a separate product domain and need a standards-based OIDC boundary
Session dataRead via GET /api/v1/directory/session/me; you cannot mutate session contentsUser identity via /userinfo; your app owns profile/session state
GuidesPath A overviewPath B overview

Both paths support LXS-hosted front-end (ship features inside the provided Vue apps) or a custom front-end that calls Directory REST APIs.

Path comparison (flows) ​

mermaid
flowchart TB
  subgraph pathA [Path A — First-Party Session]
    U1[User browser] --> FE1[LXS or custom FE on same site]
    FE1 -->|cookie + x-24g-* headers| API1[Directory API]
    API1 -->|Set-Cookie session| U1
  end

  subgraph pathB [Path B — OAuth Connected App]
    U2[User browser] --> RP[Your app / RP]
    RP -->|redirect /authorize| OP[LXS Authorization Server]
    OP -->|login if needed| Login[Directory authentication]
    Login --> OP
    OP -->|code| RP
    RP -->|POST /token| OP
    RP -->|Bearer token| API2[Directory API /userinfo]
  end
  1. Front-end: hosted vs custom — where your UI runs relative to LXS.
  2. Authentication — auth configs, strategies, and deploy headers.
  3. Path-specific guide: First-Party Session or OAuth Connected Application.
  4. Sessions (Path A) or OAuth / OIDC (Path B).
  5. REST API reference — OpenAPI spec and Swagger UI.

What this site is not ​

  • Not a substitute for tenant admin configuration in the LXS dashboard.
  • Not internal runbooks or wiki content — everything here is written for integrators consuming public Directory APIs.

Internal integrator documentation for LXS.