Docs

Invision Community API Authentication

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

Every Invision Community API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Invision Community 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 Invision Community connection in Connections. Invision Community uses OAuth. When you create the connection, you are redirected to sign in to Invision Community 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 Invision Community account that should run the action. MindCloud stores and refreshes the Invision Community 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 Community Info with an Invision Community connection looks like this:

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

Connect Invision Community with OAuth2

You need an OAuth client created in your Invision Community tenant with REST API access and the MindCloud callback URL.

  1. Create a confidential OAuth client

    In AdminCP, go to System > REST & OAuth > OAuth Clients and create a Custom Confidential OAuth Client with REST access.

  2. Use the MindCloud callback URL

    Set the Redirect URI to https://api.mindcloud.co/v1/oauth/invision/callback.

  3. Grant REST scopes

    Enable the REST scopes and endpoints MindCloud should access. Use broad read scopes first so validation can complete.

  4. Enter tenant values in the connection form

    Provide your community base URL, client identifier, and client secret, then complete the OAuth authorization flow.

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.