Docs

Lumin API Authentication

How to authenticate Lumin API requests: one Bearer API key plus a connectionId. MindCloud stores your Lumin API key securely — set it once, never resend it.

Every Lumin API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Lumin 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

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a Lumin connection in Connections. Lumin uses an API key. You generate the key in your Lumin account, then paste it in when you create the connection — MindCloud stores it securely and never returns it in a response.
  4. 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 Lumin account that should run the action. MindCloud stores and refreshes the Lumin 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 Get User Information with an Lumin connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/lumin/actions/get-user-information/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which Lumin account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect Lumin with an API key

You must sign in to a Lumin workspace as a Workspace Owner or Workspace Admin. Lumin says API keys are long-lived and should be kept secret.

  1. Sign in to Lumin Dashboard

    Open the Lumin sign-in page and sign in to the workspace you want MindCloud to use.

    Lumin sign-in
  2. Open Developer Settings

    In the Lumin Dashboard, open the Developer Settings page for your workspace.

    Developer Settings
  3. Create or copy an API key

    Generate a new API key if you do not already have one, or copy an existing active key. Lumin allows up to four active API keys per account.

    Developer Settings → API Key

  4. Paste the key into MindCloud

    Create the MindCloud connection for Lumin and paste the API key into the API key field.

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.