Docs

Hoops API Authentication

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

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

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

Create a Hoop bearer access token

You need admin access to your Hoop tenant. For managed Hoop, do not use the HOOP_KEY bootstrap secret here; this connection expects a bearer access token.

  1. Review Hoop programmatic API authentication

    Open the official Hoop CLI authentication guide and confirm whether your team will authenticate with a bearer access token issued by your identity provider.

    Docs → Command Line → Programmatic API Access
  2. Create the matching Hoop service account if you are using service-account automation

    Create or verify the Hoop service account whose subject matches the application or service account that will request tokens from your identity provider.

    Docs → API Reference → User Management → Create Service Account
  3. Issue a bearer access token

    Use your identity provider's OAuth2 client-credentials flow, or another admin-approved Hoop bearer-token flow, and copy only the access token value.

  4. Paste the token into the connection

    In MindCloud, paste the bearer token into the connection's API key field and save the connection.

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.