Repository navigation
EN Clever Generic OIDC
Français · How-to + reference · Published, reviewed by a person · Applies from: 4.2.3
Any OpenID Connect provider with discovery can log people in to the Studio from a browser. The CLI and the remote MCP need more of it. This page says what works with another provider than Keycloak, GitLab included, and what does not.
Audience, context, and the statuses of what this page rests on
Audience: admin · Context: hosted Studio
The Studio Server (hosted team Studio) · contract: experimental · verified by CI (support matrix of 4.4.0, 2026-10-23): Postgres, S3 and Keycloak in CI; Chromium and Firefox (job studio-hosted); WebKit on macOS, by hand only · automated checks: jobs
studio-hosted,studio-install-smoke; CI planstudioHosted; 3 test files · people's passes:studio-hostednot run (#149),studio-collabnot run (#150),studio-previewnot run (#166),studio-assets-hostednot run (#167),studio-mcp-remotenot run (#196),studio-oidc-genericnot run (#197) · known limits:cli-needs-jwt,no-backchannel
Browser logins to the Studio through your provider (GitLab, Authentik or another), with the same roles and invitations as with Keycloak. With a provider that issues JWT access tokens for the Studio's audience, the CLI and the remote MCP too.
- A hosted Studio on Clever Cloud, from 4.2.3 (D44: GitLab for the
studio-oidc-genericpass). -
Verified on: not verified on a live installation. The
studio-oidc-genericpass (login, roles, a revoked member refused, on a real GitLab) isnot-runfor 4.4.0. What this page says comes from the code and the guide.
-
Domains and TLS done: you know
publicUrl. - An account on the provider allowed to create an OAuth / OpenID Connect application.
The application is created in the provider's console. clever env set: on your machine, in the engine repository
where the studio app is linked.
- At the provider, create the
studioapplication as for Keycloak: a confidential client, the scopesopenid profile email, Authorization Code with PKCE S256, the redirect URI<publicUrl>/auth/callback, the post-logout redirect<publicUrl>, and the back-channel logout to<publicUrl>/auth/backchannelif the provider offers it.
-
Save its secret in a 0600 file and set it on the studio app:
# on your machine, in the engine repository clever env set --alias my-game-studio -- STUDIO_OIDC_CLIENT_SECRET "$(cat ~/secrets/my-game/oidc-client-secret)"
-
Write the provider in the configuration's
oidc. For GitLab the issuer ishttps://gitlab.com;clientIdis the application's id;audienceis any name other thanclientId(the server refuses the same):{ "issuer": "https://gitlab.com", "clientId": "<application id>", "audience": "studio-api" }Leave out
cliClientIdwhen the provider cannot serve the CLI (below):GET /auth/clithen answersclient_id: null.
Limit ·
cli-needs-jwtThe CLI and the remote MCP present the provider's access tokens as JWTs signed for this Studio's audience, lasting 5 minutes (15 at most). A provider that issues opaque access tokens (GitLab's OAuth applications, at the time of writing) does not give them: with it, the CLI and the remote MCP are not offered, or stay on a provider that does (Keycloak, Authentik and others).
Limit ·
no-backchannelWithout back-channel logout, a session ended at the provider ends in the Studio at its next check (every 5 min, by its refresh token), and a user disabled there within R = 15 min. A provider that gives no refresh token gets sessions of 15 min at most.
The Studio starts (it reads the issuer's discovery at start); an invited member logs in from a browser with the
verified email of the invitation; GET /auth/me gives their role. An invitation is consumed only by the verified
email it names: a provider that does not say the email is verified cannot accept invitations.
| Symptom | Cause | Fix |
|---|---|---|
| The member logs in but is "not a member of this project" | The provider does not report email_verified, or another email |
Check the email is verified at the provider; invite that email |
the access token is not valid from the CLI |
Opaque access tokens, or no audience | Not supported with this provider (limit above) |
oidc.maxTokenSeconds is between 30 and 900 |
A value out of range | Set 300 to 900, or leave it out (300) |
oidc.issuer must be an http(s) URL |
The issuer missing its scheme | The full URL |
The application at the provider; STUDIO_OIDC_CLIENT_SECRET and STUDIO_CONFIG_JSON on the studio app.
Switching between providers changes everyone's identity: Changing domain or OIDC provider.
| Field | Required | Value | Default |
|---|---|---|---|
issuer |
yes | the provider's issuer, an http(s) URL (its discovery is read at start) | — |
clientId |
yes | the browser client (studio) |
— |
audience |
yes | the audience the access tokens must carry; must differ from clientId
|
— |
cliClientId |
no | the public client of the device flow, given to the CLI by GET /auth/cli
|
none |
scopes |
no | the scopes of a browser login | openid email profile |
maxTokenSeconds |
no | the longest access token accepted, 30 to 900 | 300 |
allowInsecure |
no | a provider over plain http, for a local test only; never in production | false |
With oidc set, the server also requires worker, trustProxy (when it listens beyond the loopback),
STUDIO_OIDC_CLIENT_SECRET and STUDIO_SESSION_KEY (Configuration). An unknown key at
the top of the configuration is refused at start; inside oidc, an unknown field is ignored. Since 4.2.1.
-
studio-server/src/server/auth/oidc.ts,studio-server/src/server/config.ts. - ADR 0027; the Keycloak setup: Keycloak; revocation: Security.
Generated publication · publication générée — current documentation · documentation courante: quest'n'click 4.5.3 r1, documentation revision · révision de la documentation b061c4ae6fbeb0be47a11ba8a442ba7e23ecb0a1.
Latest documentation · dernière documentation: https://quest-n-click.cleverapps.io/docs · https://quest-n-click.cleverapps.io/fr/docs; earlier versions · versions précédentes: each release's quest-n-click-docs-<version>.tar.gz · l'archive quest-n-click-docs-<version>.tar.gz de chaque release, https://github.com/Quest-n-Click/quest-n-click/releases
An edit made in this wiki is overwritten at the next publication · une modification faite dans ce wiki est écrasée à la publication suivante.
Edit the source · Modifier la source · Report an error · Signaler une erreur
Index (6)
Start (6)
Play (9)
Install (18)
- Requirements
- Install from the release archive
- Install from npm
- Install from the repository to work on the engine
- doctor: checking your machine
- Image toolchain
- Audio toolchain: ffmpeg, fluidsynth, Furnace, uv
- Upgrade
- Upgrade notes: 4.5
- Upgrade notes: 4.4
- Upgrade notes: 4.3
- Upgrade notes: 4.2
- Upgrade notes: 4.1
- Upgrade notes: v3
- Upgrade notes: v2 to v3
- Coming from web-scumm
- Package reference
- Install troubleshooting
Create a game (55)
- Your first game
- Layout of a created project and of the engine repository
- The working loop
- Content principles and the identity contract
- Rooms
- Geometry: placement, walk zones, masks, layers, camera
- Something is visible but unreachable
- Reactions
- Game commands
- Conditions
- Flags, variables and events: which to use
- Custom code
- Characters
- Items and inventory
- World map
- Dialogues
- Scripts and events
- Moving characters: patrols and walks
- Exits
- Chapters and objectives
- State and saves: persistent or temporary, renaming an id, migrations
- Staging: wide rooms and animations
- The stage: lights, particles, floors
- Skin and fonts
- Title and credits
- Heroes: several characters and hero choice
- Built-in minigames
- A custom minigame
- Translations
- Music in stems
- Sound effects
- Voices: per language and per hero
- Images: prompts, cutting sheets, transparency, scale
- Asset provenance
- The storyboard, source of truth
- Puzzle design
- Classic mechanics
- Review pages
- DSL reference
- Checking your game
- What the solver proves
- Solver options
- Playtests
- Remix
- Speedrun for authors
- The sealed ending
- Production template
- Example games
- Working with an AI
- Build and release a game
- Publish on GitHub Pages
- The static game on Clever Cloud
- Other static hosts
- Sub-path, cache and service worker, incomplete deploys, going back
- Testing on a phone over the LAN
Local Studio (24)
- The local Studio: overview and launch
- Edit a room
- Placement and stage
- Preview, apply, undo
- Storyboard
- Assets and cutting
- Check: validator, solver, critical path, heat, health, coverage
- Before and after captures
- Semantic diff
- Play and replay a session
- Rule explainer
- Language and objectives
- Voices and the heroes × languages matrix
- Map
- Notes
- Remix in the Studio
- Music
- The Assistant: bring your own key
- Demo mode and studio-apply
- Local and LAN security
- Studio API
- Local MCP: setting up each client
- MCP tools
- Studio troubleshooting
Team Studio (21)
- What runs where
- Concepts: revision, transaction, span, lease, preview, build
- Starting as an invited dev
- Working together day to day
- Roles and actions: the full matrix
- Invitations
- Managing members
- Write refused on the hosted Studio: stale base revision (409)
- Write refused on the hosted Studio: span locked (423)
- Recovering after a lost lease, a disconnection or a stale preview
- Comments
- Map and semantic diff
- Publishing builds
- Remote MCP
- The game in Git
- Upgrading the engine of a hosted game
- Hosted assets
- The server's command line
- Health and metrics routes
- Trying it locally with compose.yml
- Known limits
Clever Cloud (23)
- Clever Cloud: overview, cost and prerequisites
- Apps and add-ons
- Domains and TLS
- Keycloak
- Generic OIDC and GitLab
- Configuration
- First deployment
- Backups
- RPO and RTO
- Restore the Studio on a fresh installation
- Redeploys
- Upgrading the server and checking state after a migration
- Limits of going back
- Monitoring
- Security
- Rotating keys
- Recovering admin access
- Changing domain or OIDC provider
- Worker, PostgreSQL or Cellar down
- Exporting the game and leaving the installation
- Retention
- Clever Cloud troubleshooting
- Costs and teardown
Reality Bridge and connectors (16)
- The Reality Bridge: what it is
- Quick start
- Guarantees
- Install and run the Bridge
- Backup and restore
- Several tenants
- Signals and the manifest
- The Bridge's command line
- Connectors overview
- Email connector
- Telnet connector
- SSH connector
- Open Badges connector
- The connector SDK
- Security: Biscuit and signatures
- Bridge and connector troubleshooting
Contribute (25)
- Welcome
- Developer setup
- The dev loop
- Before a pull request
- Conventions
- Writing documentation
- Architecture
- Code tour
- Import boundaries
- Which tests run when
- Mutation testing
- The coverage ratchet
- The quality baseline
- CI explained
- Field passes
- Benchmarks
- Releasing
- npm packages
- Decisions and ADRs
- Governance
- Bot pull requests
- Contributing with AI agents
- Security policy
- Code of conduct
- Licences and credits