Docs

Microsoft SQL API Authentication

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

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

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which Microsoft SQL account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Set up your Microsoft SQL connection

You need the SQL Server name, database name, username, and password for the SQL login MindCloud should use. If your SQL Server requires encryption or a non-default port, collect those details before you continue.

  1. Collect the SQL Server connection details

    Get the Server, Database, Username, and Password values for the Microsoft SQL database you want MindCloud to access.

  2. Choose the port and encryption settings

    If your administrator did not provide a custom SQL Server port, use the default TCP port 1433. Decide whether the server requires encryption and whether your environment needs ODBC enabled.

  3. Enter the connection fields in MindCloud

    In the MindCloud Microsoft SQL connection form, enter the Server, Port, Database, Username, Password, Encryption, Timeout, and Use ODBC values that match your SQL Server environment.

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.