Capabilities

Available hosting methods

Choose the hosting method that best suits your needs:

Gather Box credentials

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

A user with an administrator role in Box and and two-factor authentication set on their Box account must perform this task.

Create a new Box custom app

1. Log into the Box Developer Console.

2. Click Create New App and select Custom App.

3. Enter a name for your new app, such as “ConductorOne “, and choose how to categorize the new app.

4. When prompted to choose an authentication method for your new app, select Server Authentication (Client Credentials Grant).

5. Click Create App.

Configure your Box app and gain approval

1. Navigate to your new app’s Configuration tab.

2. In the Application Scopes area, select the following scopes:

   • Manage users
   • Manage groups
   • Manage enterprise properties
   • Grant read resource

3. In the Application Access area, select App + Enterprise Access.

4. Save your changes.

5. Submit your new custom app for approval by a Box Admin. Learn more about this process in the Box developer documentation.

Look up your new app’s credentials

1. Navigate to your new app’s Configuration tab and scroll down to the OAuth 2.0 Credentials section of the page.

2. Copy and carefully save the Client ID.

3. Navigate to the app’s General Settings page.

4. Copy and carefully save the Enterprise ID.

Add the new app to your Box instance

1. Next, in the Box Admin Console, navigate to Integrations > Platform Apps Manager.

2. Click Platform Apps Manager.

3. Click the plus sign to add a platform app to your Box instance, then enter the client ID of your new app and click Next,

4. Review the app’s information and click Authorize.

Generate a client secret

1. Return to the Box Developer Console and navigate to your new app’s Configuration tab.

2. In the App Access Level area, select App + Enterprise Access.

3. Scroll down to the OAuth 2.0 Credentials section of the page and click Fetch Client Secret.

4. Carefully copy and save the client secret.

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

Set up a Box cloud-hosted connector

To complete this task, you’ll need:

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

1. In ConductorOne, navigate to Admin > Connectors and click Add connector.

2. Search for Box and click Add.

3. Choose how to set up the new Box 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. Enter the client ID and client secret into the Client ID and Client secret fields.

8. Enter the enterprise ID into the Enterprise ID field.

9. Click Save.

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

Set up a Box cloud-hosted connector using Terraform

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

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

Set up a Box self-hosted connector

To complete this task, you’ll need:

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

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

2. Search for Baton and click Add.

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

Secrets configuration

# baton-box-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-box-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>
  
  # Box credentials
  BATON_BOX_CLIENT_ID: <Client ID used to authenticate to the Box API>
  BATON_BOX_CLIENT_SECRET: <Client secret used to authenticate to the Box API>
  BATON_ENTERPRISE_ID: <ID of your Box app>

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

Deployment configuration

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

Step 3: Deploy the connector

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

   kubectl create namespace conductorone
   

2. Apply the secret configuration:

   kubectl -n conductorone apply -f baton-box-secrets.yaml
   

3. Apply the deployment:

   kubectl -n conductorone apply -f baton-box.yaml
   

Step 4: Verify the deployment

1. Check that the deployment is running:

   kubectl -n conductorone get pods
   

2. View the connector logs:

   kubectl -n conductorone logs -l app=baton-${baton-box}
   

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

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