Skip to main content
Enterprise feature. SSO sign-in is available to organizations that have connected their identity provider (Okta, Microsoft Entra ID, Google Workspace, or another SAML/OIDC provider) to the Consus portal. If portal.consus.io doesn’t recognize your account, ask your Consus admin, or contact sales@consusindustries.co to set it up.
Every AI tool that talks to Consus Gateway needs a Consus API key. The usual way is to create a key in the portal and paste it into the tool’s settings. Each integration page shows how. There is an easier way. Install the Consus credential helper once. After that:
  1. Your tool runs the helper whenever it needs a credential. Most tools have a setting for this.
  2. The first time, the helper opens your browser to the Consus portal. You sign in with your company account and click Approve.
  3. The portal issues a key to you. The helper keeps it on your computer and hands it to the tool.
You never see the key. Your admin doesn’t need to push anything to your computer. Every request is tied to you, and your admin can revoke the key from the portal at any time. The helper itself is a short shell script you can read in a minute. It holds no secrets of its own.

Install

This puts one script at ~/.consus/helper.sh, readable by your user only. It needs curl and openssl, which every Mac and Linux machine already has.

Sign in

You can let your tool start the sign-in (its first request opens the browser), or do it now:
The portal shows which tool and which computer is asking, for example Factory on eric-mbp. Check that it’s the request you just started, then click Approve and close the tab.
Only approve a request you started yourself, on your own computer, a moment ago. If a sign-in link arrives any other way, don’t approve it.
The key stays in ~/.consus/key until it expires or you sign out. While it’s there, the helper answers instantly and makes no network calls.

Other commands

Revoke a key

To disable a key everywhere, for example after losing a laptop, revoke it in the Consus portal. It’s listed under your name with the tool and computer in its label. Admins can revoke any key in their organization.

Set up your tool

Pick your tool. Each tab shows the one setting to change; the rest of that tool’s setup is on its own integration page.
In ~/.factory/settings.json, in each customModels entry (or in Factory’s org-managed settings, which require this form):
Full setup: Factory.

How it works

  • The helper creates a one-time secret and opens portal.consus.io/cli/login with a hash of it. The portal only ever sees the hash.
  • When you approve, the helper redeems the secret with the portal. The portal mints a key for you through the same path as its own Create key button, and sends it to the helper once. The portal never stores the key.
  • A sign-in request expires after ten minutes and can be redeemed once. Each helper run waits up to 60 seconds (change it with --wait). If signing in takes longer, the tool reports an auth error and succeeds on its next try.
  • The helper only talks to portal.consus.io. Your tool only talks to api.consus.io.
  • Everything the helper stores is in ~/.consus/, readable by your user only: the key, and a small meta.json with your email, your organization, and the key’s label and expiry.

Troubleshooting