- 01 Oct 2024
- 4 Minutes to read
- Print
- DarkLight
- PDF
Box Enterprise
- Updated on 01 Oct 2024
- 4 Minutes to read
- Print
- DarkLight
- PDF
This guide will show you how to set up the integration between Box Enterprise and Clarity Security.
Estimated time to complete: 10 minutes
If you run into any problems, please contact your support team or support@claritysecurity.io.
Endpoints:
Clarity uses the following endpoints for its API connection to Box Enterprise.
/groups
/users
/users/{service_identifier}/memberships
Configuring in your Downstream Application
Step 1: Box login
Navigate to https://account.box.com/login and login with an Administrator account.
Step 2: Navigate to Dev Console
From the login page, click the Dev Console button in the bottom left hand corner.
Step 3: Create a New App
Click the Create New App button in the upper right corner.
Step 4: Choose Custom App
Choose the Custom App option.
Step 5: Name the new App
Fill out the App Name and Description, we advise something descriptive involving the name Clarity.
Step 6: Select Authentication Method
Select the authentication method: Server Authentication (Client Credentials Grant), then click Create App.
Step 7: Collect Credentials
Collect the Client ID and Client Secret, store these values securely as they will be needed in the following steps. You will need to click Fetch Client Secret to review the Copy button for Client Secret.
Step 8: Scope the Application
Fill out the Applications Scopes described and depicted below, then click Save Changes. These scopes give Clarity the necessary permissions to View Users and their access, as well as add and remove Entitlements from users, and perform any deletion or deactivation actions as necessary. This is located in the Dev Console, choose your application, then the Configuration tab.
Application Scope:
Read all files and folders stored in Box
Manage users
Manage groups
Manage enterprise properties
Step 9: Configure App Access Level
Choose App + Enterprise Access in the App Access Level section of the Configuration tab.
Step 10: Collect the Enterprise ID
Collect the Enterprise ID from the App that you created. This is located in the Dev Console, choose your application, then the General Settings tab.
Step 11: Navigate to Admin console > Apps
Navigate to the Admin Console, then to the Apps page. You may need to head back to your dashboard/main page to see the Admin Console button (see image in Step 2, bottom left corner).
Step 12: Navigate to Custom Apps Manager
Click on the Custom Apps Manager button near the top middle of the page.
Step 13: Add the new Custom App
Click the Add App button in the top right corner to add the Custom App you just created. Client ID (from Step 7) will be required in the next step.
Step 14: Provide the Client ID
Copy and paste the Client ID you obtained above (in Step 7) to add this application to your Box Enterprise tenant.
Step 15: Review & Authorize
Review the details of the custom app you created above, then click Authorize.
Configuring the Integration within Clarity
Step 1: Login to your Clarity Security tenant
https://your-tenant.claritysecurity.io/
Step 2: Click on Applications, then Marketplace
Step 3: Find Box Enterprise
Scroll to or search for Box Enterprise in the list of applications from the marketplace, then click Connect App.
Step 4: Connect App
Complete the Connect App form. Details for fields common to all applications can be found at the following article: Common App Configuration Steps
client_id: This is Client ID collected in Step 7.
client_secret: This is Client Secret collected in Step 7.
box_subject_id: This is Enterprise ID collected in Step 9.
Step 4: App Settings
Complete the App Settings form. Details for each field can be found at the following article: Common App Configuration Steps
Step 5: User Settings
Complete the User Settings form. Details for each field can be found at the following article: Common App Configuration Steps
Step 6: Validate Your Selections and Save
Validate the selections from Configure App Step 3, and hit the Save button.
Save
Clicking the Save button will trigger the first full sync for your application (even if you selected Manual syncing). This includes Service Users, Entitlements, Service User Entitlements, Service User Attributes.
Need Help?
If you have any problems, contact your customer success team. You can also get in touch with our general support via email, open a support ticket. Our general support team is available Monday - Friday from 8:00 AM - 6:30 PM CST.