Capabilities

Available hosting methods

Choose the hosting method that best suits your needs:

Gather Formal credentials

Each setup method 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

1. Sign into Formal and click the API Keys tile.

2. Click Create API Key.

3. Give the new key a name, such as “ConductorOne integration”.

4. Click Create. The new API key is generated.

5. Carefully and copy and save the API key.

That’s it! Next, move on to the instructions for your chosen setup method.

Set up a Formal cloud-hosted 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

1. In ConductorOne, click Connectors > Add connector.

2. Search for Formal and click Add.

3. 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

4. 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.

5. Click Next.

6. Find the Settings area of the page and click Edit.

7. Paste the API key into the API key field.

8. Click Save.

9. 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.

Set up a Formal cloud-hosted connector using Terraform

As an alternative to the cloud-hosted setup process described above, you can use Terraform to configure the integration between Formal and ConductorOne.

See the ConductorOne Formal integration resource page in the ConductorOne Terraform registry for example usage and the full list of required and optional parameters.

Set up a Formal self-hosted 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

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.

Why use Kubernetes? Kubernetes provides automated deployment, scaling, and management of your connectors. It ensures high availability and reliable operation of your connector services.

Step 1: Configure the Formal connector

1. In ConductorOne, navigate to Connectors > Add connector.

2. Search for Baton and click Add.

3. 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

4. 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.

5. Click Next.

6. In the Settings area of the page, click Edit.

7. 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
        args: ["service"]
        imagePullPolicy: IfNotPresent
        envFrom:
        - secretRef:
            name: baton-formal-secrets

Step 3: Deploy the connector

1. Create a namespace in which to run ConductorOne connectors (if desired):

   kubectl create namespace baton-formal
   

2. Apply the secret configuration:

   kubectl -n baton-formal apply -f baton-formal-secrets.yaml
   

3. Apply the deployment:

   kubectl -n baton-formal apply -f baton-formal.yaml
   

Step 4: Verify the deployment

1. Check that the deployment is running:

   kubectl -n c1 get pods
   

2. View the connector logs:

   kubectl -n c1 logs -l app=baton-${baton-formal}
   

3. 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.