Skip to main content

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