Skip to main content

Connection users

Who can use a connection. Each user reads data with their own access to the connection; a user without one uses the default user's, when the connection has one.

With autoProvision on, new members of the organization get access on their own. Removing a user also deletes the syncs that read through their access.

List connection users

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

The users with access to a connection, with whether each is the default user and whether their access works. Only its admins may.

Requires the connections:read scope.

Operation ID: listConnectionUsers.

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.

Response 200

Success

application/json: array of object

  • userId (number, required): Identifies the user, as their id in listMembers. Pass it as userId to removeConnectionUser, or as defaultUserId to updateConnection to make them the default user.
  • email (string, required): The email address of the user's Rollstack account.
  • isDefault (boolean, required): Whether this user is the connection's default user, called its service account in the app. While a connection has a default user, Rollstack reads data through the default user's access for everyone with access to the connection, instead of through their own. A connection has at most one, set with defaultUserId in updateConnection; Databricks connections can't have one.
  • 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.

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.

Suspend connection user

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

Suspends a user's access to a connection. Their syncs stay but stop updating until addConnectionUsers gives them access again or someone takes their reports over. Only its admins may, and never for the default user.

Requires the connections:write scope.

Operation ID: removeConnectionUser.

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.
  • userId (integer, required): The member to act on, by their id from listMembers. For removeConnectionUser, one of the connection's users, as listed by listConnectionUsers. For setConnectionAdmin, any active member of your organization except the connection's owner. For removeConnectionAdmin, one of the connection's admins, as listed in admins by getConnection, except its owner.

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.

Response 204

Success, no content