Capabilities

Available hosting methods

Choose the hosting method that best suits your needs:

Gather PrivX credentials

Each setup method requires you to pass in credentials generated in PrivX. Gather these credentials before you move on.

A user with the Admin role in PrivX must perform this task.

Set up a PrivX role

First, create a PrivX role that will be used to grant permissions to the API client you’ll use to integrate with ConductorOne.

1. In PrivX, navigate to Administration > Roles and click Add Role.

2. Create a new role (or locate an existing role) with the following permissions:

   • roles-view
   • users-view
   • role-target-resources-view

3. Make a note of the name of the role.

Create a PrivX API client

1. Still in PrivX, navigate to Administration > Deployment and click Integrate with PrivX Using API Clients.

2. Click Add API Client.

3. Give the new client a name and assign it the role you just created or identified.

4. Click Save.

5. Scroll down to the Credentials section of the page. Carefully copy and save the OAuth Client ID and Client Secret, and the API Client ID and Client Secret.

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

Set up a PrivX cloud-hosted connector

To complete this task, you’ll need:

• The Connector Administrator or Super Administrator role in ConductorOne
• Access to the set of PrivX credentials generated by following the instructions above

1. In ConductorOne, click Connectors > Add connector.

2. Search for PrivX and click Add.

3. Choose how to set up the new PrivX 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. Select your preferred authentication method, OAuth or Client secret:

   • For OAuth, enter your PrivX base URL and paste in the OAuth credentials.

   • For Client secret, enter your PrivX base URL and paste in the API client credentials.

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 PrivX connector is now pulling access data into ConductorOne.

Set up a PrivX 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 PrivX and ConductorOne.

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

Set up a PrivX self-hosted connector

To complete this task, you’ll need:

• The Connector Administrator or Super Administrator role in ConductorOne
• Access to the set of PrivX 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 PrivX connector

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

2. Search for Baton and click Add.

3. Choose how to set up the new PrivX 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 PrivX connector deployment:

Secrets configuration

# baton-privx-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-privx-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>
  
  # PrivX credentials, option 1
  BATON_API_CLIENT_ID: <PrivX API client ID>
  BATON_API_CLIENT_SECRET: <PrivX API client secret>
  BATON_BASE_URL: <PrivX instance base URL>

  # PrivX credentials, option 2
  BATON_OAUTH_CLIENT_ID: <PrivX OAuth client ID>
  BATON_OAUTH_CLIENT_SECRET: <PrivX OAuth client secret>
  BATON_BASE_URL: <PrivX instance base URL>

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

Deployment configuration

# baton-privx.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-privx
  labels:
    app: baton-privx
spec:
  selector:
    matchLabels:
      app: baton-privx
  template:
    metadata:
      labels:
        app: baton-privx
        baton: true
        baton-app: privx
    spec:
      containers:
      - name: baton-privx
        image: ghcr.io/conductorone/baton-privx:latest
        args: ["service"]
        imagePullPolicy: IfNotPresent
        envFrom:
        - secretRef:
            name: baton-privx-secrets

Step 3: Deploy the connector

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

   kubectl create namespace baton-privx
   

2. Apply the secret configuration:

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

3. Apply the deployment:

   kubectl -n baton-privx apply -f baton-privx.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-privx}
   

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 PrivX connector to. PrivX data should be found on the Entitlements and Accounts tabs.

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