Sign inGet started
Docs
Get started

UserBit API Authentication

How to authenticate UserBit API requests: one Bearer API key plus a connectionId. MindCloud handles UserBit's custom auth scheme for you.

Every UserBit API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your UserBit 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 UserBit connection in Connections. UserBit uses its own authentication scheme. You provide whatever it requires when you create the connection — MindCloud handles the provider-specific details for you.
  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 UserBit account that should run the action. MindCloud stores and refreshes the UserBit 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 Workspaces with an UserBit connection looks like this:

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

Set up your UserBit Firebase token

You need a valid UserBit account plus the Firebase API key, refresh token, and workspace information for your tenant.

  1. Get or refresh a Firebase ID token

    If your current UserBit token has expired, call Firebase Secure Token with your UserBit Firebase API key and refresh token: POST https://securetoken.googleapis.com/v1/token?key=[API_KEY] with form data grant_type=refresh_token&refresh_token=[REFRESH_TOKEN].

  2. Fill the connection fields

    Paste the fresh Firebase ID token into ID Token. Store the refresh token, Firebase API key, workspace ID, and optional User ID in the remaining fields.

  3. Refresh when the bearer token expires

    Repeat the Firebase Secure Token refresh request whenever UserBit returns Token Expired, then update the stored ID Token value.

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.