Skip to main content

Add connection users

POST https://api.rollstack.com/public/v1/connections/{type}/{id}/users

Gives members of the organization access to a connection. Only its admins may. Answers the users who got access; others are skipped.

Requires the connections:write scope.

Operation ID: addConnectionUsers.

Path parameters

  • type (string, required): The data source the connection reads from: Tableau, Looker, Metabase, PowerBI, Lightdash, Omni, Sigma or Salesforce, or the Snowflake, Databricks or BigQuery data warehouse. Endpoints that act on a connection take it in their path, with the connection's id. One of Tableau, Looker, Metabase, PowerBI, Lightdash, Omni, Sigma, Salesforce, Snowflake, Databricks, BigQuery.
  • id (string, required): Unique identifier for the connection, from listConnections, which also returns its type.

Headers

  • Idempotency-Key (string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.

Request body, required

application/json

  • userIds (array of integer, required): The members of your organization to give access to the connection, by their id from listMembers. Depending on the BI tool, some may still have to enter their own credentials in the app, such as a Lightdash personal access token, before their access works: isActive in the response tells you which. Members whose access was suspended get it back. Members who already have access, and ids that aren't active members of your organization, are skipped. From 1 to 100 ids.

Response 201

Success

application/json: array of object

  • userId (number, required): Identifies a member who got access with this request, as their id in listMembers. Members who were skipped aren't listed.
  • isActive (boolean, required): Whether the user's access to the connection is set up and working, shown as Active or Inactive in the connection's list of users in the app. It is false, for example, until a Lightdash user enters their personal access token in the app, or when Rollstack couldn't connect to Tableau as that user. It is also false while their access is suspended.