Keygen API Authentication
How to authenticate Keygen API requests: one Bearer API key plus a connectionId. MindCloud stores your Keygen API key securely — set it once, never resend it.
Every Keygen API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Keygen account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.
Steps to authenticate
- Create a MindCloud account at app.mindcloud.co if you do not already have one.
- Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
- Create a Keygen connection in Connections. Keygen uses an API key. You generate the key in your Keygen account, then paste it in when you create the connection — MindCloud stores it securely and never returns it in a response.
- Copy the connection’s
connectionId— you will send it on every request alongside your MindCloud API Key.
How requests are authenticated
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Keygen account that should run the action. MindCloud stores and refreshes the Keygen credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.
For example, calling with an Keygen connection looks like this:
The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which Keygen account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.
Connect your Keygen account
You need access to your Keygen account and the target environment in the Keygen dashboard.
- Sign in to the Keygen dashboard
Open the Keygen dashboard in your browser and sign in with your work account.
Keygen Dashboard - Copy your account slug or UUID
Open Account Settings and copy the Current Account slug or UUID. MindCloud uses this value as the account path segment in every API request.
- Generate an environment token
Open the environment you want MindCloud to use, then generate a token from that environment's Tokens relationship. Copy the token immediately after it is created, because Keygen only shows the raw value once.
- Paste both values into MindCloud
Return to the MindCloud connection form and paste the account slug or UUID plus the bearer token. Save the connection when both fields are filled in.
Keep your key safe
Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.