Sign inGet started
Docs
Get started

ReadyCloud Suite API Authentication

How to authenticate ReadyCloud Suite API requests: one Bearer API key plus a connectionId. MindCloud runs the OAuth flow and refreshes tokens for you.

Every ReadyCloud Suite API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your ReadyCloud Suite 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 ReadyCloud Suite connection in Connections. ReadyCloud Suite uses OAuth. When you create the connection, you are redirected to sign in to ReadyCloud Suite and approve access — MindCloud stores the resulting tokens and refreshes them automatically, so your integration never has to.
  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 ReadyCloud Suite account that should run the action. MindCloud stores and refreshes the ReadyCloud Suite 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 Organizations with an ReadyCloud Suite connection looks like this:

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

Get a ReadyCloud API key

You need a ReadyCloud account you can sign in to at www.readycloud.com.

  1. Create a ReadyCloud app and copy the App ID

    Open the ReadyCloud API Getting Started guide and follow the Getting a Client ID section. ReadyCloud instructs you to create an app, open it, click Edit, and copy the App ID. That App ID is the client_id used in the authorization URL.

    ReadyCloud API v2 → Pre-Authorization Steps → Getting a Client ID
  2. Build the authorization URL

    Use ReadyCloud's authorization endpoint, set response_type to token, include your client_id, and include the scopes your team selected for this ReadyCloud build.

    ReadyCloud API v2 → Pre-Authorization Steps → Creating a URL
  3. Approve access and copy the access token

    While signed in to ReadyCloud, open your authorization URL and click Allow. ReadyCloud then shows a URL containing an access_token fragment. Copy that access token and paste it into this MindCloud connection.

    ReadyCloud API v2 → Authorizing Your Application → Getting the API Key

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.