Set up Retool connector

Capabilities

The Retool connector syncs the following resources:

Resource	Sync	Provision
Accounts		Create, Enable/Disable
Groups		Grant, Revoke
Organizations
Pages (Apps)		Grant, Revoke
Resources

Notes:

Sync and group/page provisioning use a direct connection to the Retool Postgres database (the connection-string setting). The account lifecycle (Create and the enable/disable actions) additionally uses the Retool REST API and requires the retool-api-base-url and retool-api-token settings — sync-only deployments work without them.
Retool’s API does not expose a hard delete, so the connector does not offer account deletion. Deprovisioning is the disable_user action, which deactivates the account (blocks sign-in) while retaining the user and its group memberships; the enable_user action reactivates it.

Gather Retool credentials

Configuring the connector requires you to pass in credentials generated in Retool. Gather these credentials before you move on.

A user with the ability to create a new user in Retool must perform this task.

Create a Retool user and compose the connection string

Connect to the Retool database and create a new user. The connector will use this user to connect to the PostGreSQL database. Make sure to create and save a secure password:CREATE USER baton WITH PASSWORD 'secure-password';

Grant the new user the following privileges, which are required by the connector for inspecting Retool privileges:

GRANT SELECT ("id", "name", "organizationId", "universalAccess", "universalResourceAccess", "universalQueryLibraryAccess", "userListAccess", "auditLogAccess", "unpublishedReleaseAccess") ON groups TO baton;
GRANT SELECT, INSERT, UPDATE ("id", "accessLevel"), DELETE ON group_pages TO baton;
GRANT SELECT, INSERT, UPDATE ("id", "accessLevel") ON group_folder_defaults TO baton;
GRANT SELECT, INSERT, UPDATE ("id", "accessLevel") on group_resources TO baton;
GRANT SELECT, INSERT, UPDATE ("id", "accessLevel") on group_resource_folder_defaults TO baton;
GRANT SELECT ("id", "name") ON organizations TO baton;
GRANT SELECT ("id", "name", "organizationId", "folderId", "photoUrl", "description", "deletedAt") ON pages TO baton;
GRANT SELECT ("id", "name", "organizationId", "type", "displayName", "environmentId", "resourceFolderId") ON resources TO baton;
GRANT SELECT ("id", "email", "firstName", "lastName", "profilePhotoUrl", "userName", "enabled", "lastLoggedIn", "organizationId") ON users TO baton;
GRANT SELECT, INSERT, UPDATE, DELETE ("id", "userId", "groupId", "isAdmin", "updatedAt") ON user_groups TO baton;
GRANT USAGE, SELECT ON SEQUENCE user_groups_id_seq TO baton;
GRANT DELETE ON user_groups TO baton;

Compose and save the Retool connection string you’ll use when setting up the connector. This string will be in this form:"user=baton password=secure-password host=localhost port=5432 dbname=hammerhead_production"

(Optional) Create a Retool API token for account provisioning

Account creation and the enable/disable user actions use the Retool REST API. Skip this section if you only need sync and group/page provisioning.

A Retool admin must perform this task, and your Retool plan must include REST API access.

In Retool, go to Settings > API and create a new API token.

Grant the token the users:read and users:write scopes (both are required to create, look up, and enable/disable users).

Copy and save the token, and note your Retool base URL (for example https://<your-org>.retool.com). You’ll provide both when configuring the connector.

Done. Next, move on to the connector configuration instructions.

Configure the Retool connector

To complete this task, you’ll need:

The Connector Administrator or Super Administrator role in C1
Access to the set of Retool credentials generated by following the instructions above

Cloud-hosted
Self-hosted

Follow these instructions to use a built-in, no-code connector hosted by C1.Cloud-hosted connector not currently available.

Follow these instructions to use the Retool connector, hosted and run in your own environment.When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with C1, automatically syncing and uploading data at regular intervals. This data is immediately available in the C1 UI for access reviews and access requests.

Resources

GitHub repository: Access the source code, report issues, or contribute to the project.

Step 1: Set up a new Retool connector

In C1, navigate to Integrations > Connectors > Add connector.

Search for Baton and click Add.

Choose how to set up the new Retool connector:

Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with C1)
Add the connector to a managed app (select from the list of existing managed apps)
Create a new managed app

Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of C1 users. Setting multiple owners is allowed.If you choose someone else, C1 will notify the new connector owner by email that their help is needed to complete the setup process.

Click Next.

In the Settings area of the page, click Edit.

Click Rotate to generate a new Client ID and Secret.Carefully copy and save these credentials. We’ll use them in Step 2.

Step 2: Create Kubernetes configuration files

Create two Kubernetes manifest files for your Retool connector deployment:

Secrets configuration

# baton-retool-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-retool-secrets
type: Opaque
stringData:
  # C1 credentials
  BATON_CLIENT_ID: <C1 client ID>
  BATON_CLIENT_SECRET: <C1 client secret>
  
  # Retool credentials
  BATON_CONNECTION_STRING: <The Retool connection string, in format "user=baton password=secure-password host=localhost port=5432 dbname=hammerhead_production">

  # Optional: required only for account creation and enable/disable actions (REST API)
  BATON_RETOOL_API_BASE_URL: <Your Retool base URL, e.g. https://your-org.retool.com>
  BATON_RETOOL_API_TOKEN: <Retool API token with users:read + users:write scopes>

  # Optional: include if you want C1 to provision access using this connector
  BATON_PROVISIONING: "true"

See the connector’s README or run --help to see all available configuration flags and environment variables.

Deployment configuration

# baton-retool.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-retool
  labels:
    app: baton-retool
spec:
  selector:
    matchLabels:
      app: baton-retool
  template:
    metadata:
      labels:
        app: baton-retool
        baton: "true"
        baton-app: retool
    spec:
      containers:
      - name: baton-retool
        image: public.ecr.aws/conductorone/baton-retool:latest
        imagePullPolicy: IfNotPresent
        env:
        - name: BATON_HOST_ID
          value: baton-retool
        envFrom:
        - secretRef:
            name: baton-retool-secrets

Step 3: Deploy the connector

Create a namespace in which to run C1 connectors (if desired), then apply the secret config and deployment config files.

Check that the connector data uploaded correctly. In C1, click Apps. On the Managed apps tab, locate and click the name of the application you added the Retool connector to. Retool data should be found on the Entitlements and Accounts tabs.

Done. Your Retool connector is now pulling access data into C1.

You can download the latest baton-retool release binaries from the ConductorOne download center.

⌘I

Welcome

Manage connectors

Deploy connectors

Upload connector data

Configurable connectors

Pre-built connectors

Set up Retool connector

Capabilities

Gather Retool credentials

Create a Retool user and compose the connection string

(Optional) Create a Retool API token for account provisioning

Configure the Retool connector

Resources

Step 1: Set up a new Retool connector

Step 2: Create Kubernetes configuration files

Secrets configuration

Deployment configuration

Step 3: Deploy the connector

​Capabilities

​Gather Retool credentials

​Create a Retool user and compose the connection string

​(Optional) Create a Retool API token for account provisioning

​Configure the Retool connector

​Resources

​Step 1: Set up a new Retool connector

​Step 2: Create Kubernetes configuration files

​Secrets configuration

​Deployment configuration

​Step 3: Deploy the connector

Capabilities

Gather Retool credentials

Create a Retool user and compose the connection string

(Optional) Create a Retool API token for account provisioning

Configure the Retool connector

Resources

Step 1: Set up a new Retool connector

Step 2: Create Kubernetes configuration files

Secrets configuration

Deployment configuration

Step 3: Deploy the connector