Skip to main content

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.