ConductorOne docs

Set up a Formal connector

ConductorOne provides identity governance and just-in-time provisioning for Formal. Integrate your Formal instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests.

Capabilities

Resource	Sync	Provision
Accounts	✅
Groups	✅	✅

Gather Formal credentials

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

A user with the Connector Administrator or Super Administrator role in ConductorOne and the ability to generate API keys in Formal must perform this task.

Generate a Formal API key

Sign into Formal and click the API Keys tile.
Click Create API Key.
Give the new key a name, such as “ConductorOne integration”.
Click Create. The new API key is generated.
Carefully and copy and save the API key.

That’s it! Next, move on to the connector configuration instructions.

Configure the Formal connector

To complete this task, you’ll need:
The Connector Administrator or Super Administrator role in ConductorOne
Access to the set of Formal credentials generated by following the instructions above

Follow these instructions to use a built-in, no-code connector hosted by ConductorOne.

In ConductorOne, navigate to Admin > Connectors and click Add connector.
Search for Formal and click Add.
Choose how to set up the new Formal 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 ConductorOne)
- 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 ConductorOne users. Setting multiple owners is allowed.
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
Click Next.
Find the Settings area of the page and click Edit.
Paste the API key into the API key field.
Click Save.
The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.

That’s it! Your Formal connector is now pulling access data into ConductorOne.

Follow these instructions to use the Formal connector, hosted and run in your own environment.

When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with ConductorOne, automatically syncing and uploading data at regular intervals. This data is immediately available in the ConductorOne UI for access reviews and access requests.

Step 1: Set up a new Formal connector

In ConductorOne, navigate to Connectors > Add connector.
Search for Baton and click Add.
Choose how to set up the new Formal 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 ConductorOne)
- 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 ConductorOne users. Setting multiple owners is allowed.
If you choose someone else, ConductorOne 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 Formal connector deployment:

Secrets configuration

# baton-formal-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-formal-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>
  
  # Formal credentials
  BATON_FORMAL_API_KEY: <Formal API key>

  # Optional: include if you want ConductorOne 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-formal.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-formal
  labels:
    app: baton-formal
spec:
  selector:
    matchLabels:
      app: baton-formal
  template:
    metadata:
      labels:
        app: baton-formal
        baton: true
        baton-app: formal
    spec:
      containers:
      - name: baton-formal
        image: ghcr.io/conductorone/baton-formal:latest
        imagePullPolicy: IfNotPresent
        envFrom:
        - secretRef:
            name: baton-formal-secrets

Step 3: Deploy the connector

Create a namespace in which to run ConductorOne connectors (if desired), then apply the secret config and deployment config files.
Check that the connector data uploaded correctly. In ConductorOne, click Applications. On the Managed apps tab, locate and click the name of the application you added the Formal connector to. Formal data should be found on the Entitlements and Accounts tabs.

That’s it! Your Formal connector is now pulling access data into ConductorOne.