How to read this documentation
The LuxID documentation is a map, not a book: pick a layer based on what you are trying to do today, jump in, and follow the cross-references when you need depth.
The LuxID documentation is not a book that reads from page 1 to page 500. It is a map. Pick a layer based on what you are trying to do today, jump in there, and follow the cross-references when you need depth.
Four short questions
The whole documentation answers four questions in order. If you know which one matters to you right now, you know where to start.
- What is LuxID? -> Get started, Concepts and fundamentals
- How do I wire up sign-in? -> Quick Integrations (no code) or Authenticate (code)
- How do I make it recognisable and safe? -> UX and branding, Secure
- What extra value can I draw from LuxID, and how do I run it in production? -> Features, LuxID Console, APIs and advanced, Governance, Troubleshooting
Five layers
Layer 1 - understand
Sections: Get started, Concepts and fundamentals.
Build shared vocabulary before touching code. You learn what LuxID is, who runs it, the Organization / Partner / Application / Sphere / Subscription model, what OIDC tokens contain, and how LuxID's auth_level scale (LuxID's own authentication-strength classification) relates to the eIDAS Low / Substantial / High rationale and when eIDAS LoA values from qualified upstreams appear in LuxID payloads.
Outcome. You can hold a coherent conversation about LuxID with anyone in the project.
Layer 2 - integrate
Sections: Quick Integrations, Authenticate.
Get login working. Two paths:
- A. No code for SaaS tools that already speak OIDC or SAML (Odoo, WordPress, Drupal, ServiceNow, Microsoft 365, ...). Configuration only, typical 10 to 30 minutes.
- B. Custom code for in-house applications using a library (Spring Security, openid-client, AppAuth, NextAuth, ...).
You also learn how the UAT sandbox works and its constraints.
Outcome. Real users can sign in to your application with LuxID.
Layer 3 - design and trust
Sections: UX and branding, Secure.
Make the sign-in step recognisable so users trust it, and make it robust so attackers can not abuse it. Across all Luxembourg services using LuxID, consistency of the button, the consent screen, and the recovery flow is a phishing defence on its own.
Outcome. Your sign-in is not just functional - it is consistent with every other LuxID-enabled service and resilient to the common OIDC/OAuth attack patterns.
Layer 4 - enhance
Sections: Features, APIs and advanced, Testing and tooling.
Go beyond basic login. Use LuxID Verified for identity proofing, LuxID Pro for enterprise federation, the Event Hub for real-time signals, risk scoring claims to harden sensitive operations, and so on. This is where LuxID stops looking like a generic OIDC endpoint and starts behaving like an identity intelligence platform.
Outcome. You ship features that would have required wiring three separate vendors elsewhere.
Layer 5 - operate and comply
Sections: LuxID Console, Governance, trust and compliance, Troubleshooting and support.
Run it in production: rotate credentials, inspect logs, manage redirect URIs and environments, sign legal agreements, hit your SLA targets, and recover when something goes wrong.
Outcome. Your service stays stable, compliant, and maintainable over years - not just on launch day.
Persona reading paths
These are paths through the layers, not exhaustive lists.
Backend developer
- Get Started / LuxID Onboarding
- Concepts / Tokens and Claims
- Get Started / Configure LuxID - obtaining your Client ID and Secret (operational tasks live in the planned LuxID Console)
- Authenticate / Add Login then OpenID Connect
- Secure / Protect Your Application then Session management
- Features as needed
- Testing and tooling - in particular the Token debugger and Attribute preview tool
Frontend or mobile developer
- Get started
- Authenticate / Platform and Framework Guides
- UX and Branding / Login Button Guidelines
- UX and Branding / Multi-Factor UX
- Troubleshooting
IT administrator
- Get Started / Configure LuxID
- Quick Integrations
- Features / Single Sign-On and LuxID Pro - if you are federating a corporate IdP (Microsoft Entra, Google Workspace, ADFS, ...)
- UX and Branding / Login Button Guidelines
- Troubleshooting and support
Architect
- Concepts and fundamentals
- Get Started / Plan and Design
- Secure
- Features
- APIs and advanced
- Governance / Trust Framework
Product owner or designer
- Get Started / LuxID Onboarding
- Get Started / Plan and Design
- UX and branding
- Features
- Governance and Compliance
Security or compliance officer
- Concepts / Assurance Levels
- Secure
- Features / Security Signals and Risk Scoring and LuxID Verified
- Governance and Compliance
Enterprise or government IT
- Get started
- Quick Integrations or Authenticate
- Features / Single Sign-On (LuxID Pro) and LuxID Verified
- LuxID Console (planned self-service surface; operational requests today go via contact)
- Governance and Compliance
One sentence per top-level section
| Section | One-sentence summary |
|---|---|
| Get started | Orientation, the 15-minute Quickstart, and how to obtain credentials. |
| Quick Integrations | Configure LuxID in off-the-shelf SaaS tools without writing code. |
| Concepts and fundamentals | The vocabulary you need before you write a single line. |
| Authenticate | OIDC, OAuth 2.0, and SAML implementation guides with library examples. |
| UX and branding | Buttons, brand assets, consent screen, and user-journey patterns. |
| Secure | Token storage, session management, key handling, and advanced security options. |
| Features | Universal Login, MFA, passkeys, risk signals, LuxID Verified, LuxID Pro, OpenRoaming, attribute enrichment. |
| LuxID Console | The planned self-service portal where Application registration, redirect URI management, credential rotation and log inspection will live. Operations are handled by LuxID in the interim. |
| APIs and advanced | UserInfo, introspection, revocation, webhooks, delegated authorization, cross-border federation, Partner API. |
| Testing and tooling | Sandbox, token debugger, consent simulator, Postman collections. |
| Governance, trust and compliance | Trust framework, accreditation, legal agreements, GDPR, SLA, roadmap. |
| Troubleshooting and support | Error catalogue, FAQ, support channels. |
In one sentence: this documentation is organised from "get login working" to "build a trusted Luxembourgish digital identity experience".