Docs

PPM Express API Authentication

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

Every PPM Express API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your PPM Express 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 PPM Express connection in Connections. PPM Express uses an API key. You generate the key in your PPM Express 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 PPM Express account that should run the action. MindCloud stores and refreshes the PPM Express 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 Current User with an PPM Express connection looks like this:

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

Connect PPM Express

Generate a PPM Express public API bearer token and confirm your tenant slug from the URL format https://app.ppm.express/us/@tenantName/...

  1. Create a bearer token

    In PPM Express, generate a public API token with the scopes you need for the records you plan to access.

  2. Find your tenant name

    Use the value after @ in your PPM Express URL, for example @mindcloud means the tenant name is mindcloud.

  3. Enter the connection values

    Paste the bearer token into the API key field and enter the tenant name without the @ symbol.

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.