Teamgate API Authentication

How to authenticate Teamgate API requests: one Bearer API key plus a connectionId. MindCloud handles Teamgate's custom auth scheme for you.

Every Teamgate API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Teamgate 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 Teamgate connection in Connections. Teamgate uses its own authentication scheme. You provide whatever it requires when you create the connection — MindCloud handles the provider-specific details for you.
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 Teamgate account that should run the action. MindCloud stores and refreshes the Teamgate 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 List Users with an Teamgate connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/teamgate/actions/list-users/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 Teamgate account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect Teamgate

You need a Teamgate account with access to External Apps and API access.

Copy your App Key
In Teamgate, open the External Apps page and copy the Application Key for your MindCloud app entry. Paste that value into the MindCloud "App Key" field.
Settings → Additional Features → External Apps
Copy your Auth Token
Open your API access page in Teamgate and copy your personal AUTH_TOKEN. Paste that value into the MindCloud "Auth Token" field.
My Profile → Integrations → API access
Save and test the connection
Back in MindCloud, enter both values, save the connection, and run the test action. The test action should return Teamgate user records when the credentials are valid.

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.