Zahara API Authentication
How to authenticate Zahara API requests: one Bearer API key plus a connectionId. MindCloud handles Zahara's custom auth scheme for you.
Every Zahara API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Zahara 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 Zahara connection in Connections. Zahara 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 Zahara account that should run the action. MindCloud stores and refreshes the Zahara 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 (Business Unit) with an Zahara connection looks like this:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/zahara/actions/list-users-business-unit/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 Zahara account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.
Get your Zahara API credentials
You need a Zahara login with an active tenant or trial and access to the Zahara admin settings for that tenant.
- Create or confirm your Zahara tenant access
Sign in to an active Zahara tenant. If you do not have access yet, start a trial or ask your Zahara admin to invite you.
- Copy the tenancy API key
In Zahara, open the admin settings and go to the Integrations area. Copy the tenancy API key for your tenant.
- Get the business unit API key
Use Zahara's Get Business Units endpoint with your tenancy API key. Zahara's documentation says this endpoint returns every business setting for the tenancy. From the business unit you want to use, copy the business unit API key from the returned settings.
- Get the tenancy ID if you will use reporting
If you will use reporting or SmartSync+ exports, copy the tenancy ID for the same tenant. Zahara's reporting guide says the tenancy ID is usually hidden and may need to be provided by Zahara.
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.