Skip to main content

Connection admins

Who can manage a connection. A connection has one owner and any number of admins. Admins manage the connection's users; only the owner can add or remove admins, or delete the connection.

Ownership moves only in the app.

Add connection admin

PUT https://api.rollstack.com/public/v1/connections/{type}/{id}/admins/{userId}

Makes an active member an admin of a connection. Only its owner may.

Requires the connections:write scope.

Operation ID: setConnectionAdmin.

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.

Request body, required

application/json

  • role (string, required): The role to give the member on the connection. Only admin is accepted: admins manage the connection's users and can change its settings and credentials, while only the owner can delete the connection or add and remove admins. Ownership can be transferred only in the app. Being an admin doesn't make them one of the connection's users: add them with addConnectionUsers too if they need access of their own. One of admin.

Response 200

Success

application/json

  • userId (number, required): The member who is now an admin of the connection, as their id in listMembers.
  • role (string, required): The member's role on the connection, always admin here. Admins manage the connection's users, settings and credentials. The other role, owner, belongs to the connection's owner, who can also delete the connection and choose its admins; it can't be given through the API. One of owner, admin.

Remove connection admin

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

Removes an admin of a connection. Only its owner may, and the owner's own role stays.

Requires the connections:write scope.

Operation ID: removeConnectionAdmin.

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