Box Capabilities

After this article...

You'll understand the capabilities our Box integration provides, and how Lumos interacts with the Box API.

View users

The mapping between Box user statuses and Lumos user account statuses is below.

Box API endpoint: https://developer.box.com/reference/get-users/

View a user's entitlements

Lumos can retrieve the following user entitlements from Box.

• Role - Whether the user is a Box Admin, Coadmin, or User

Box API endpoint: https://developer.box.com/reference/resources/user--full/#param-role

View a user's last login

In Lumos, the Last Login value represents the last time the user logged into Box.

When you connect Box, Lumos will pull the last 6 months of admin logs from Box and look for "LOGIN" event types.

Box API endpoint: https://developer.box.com/reference/get-events/ (we specify "admin_logs" and look for "LOGIN" event types).

Suspend a user

In Lumos, suspending a Box user marks their Account Status as "Suspended".

In Box, this action marks the user as "Inactive".

Box API endpoint: https://developer.box.com/reference/put-users-id/ (we set the user status to "inactive")

Deprovision a user

In Lumos, deprovisioning a Box user marks their Account Status as "Deprovisioned".

In Box, this action deletes the user. This action will fail if the user's account still has content associated with it. You would need to transfer data to another user in Box if you're carrying out this action in Lumos outside of offboarding. See📄 Offboarding Employees in Lumos

Box API endpoint: https://developer.box.com/guides/users/delete-user/

Transfer data

* Available only in Inactivity Workflows

In Lumos, transferring a Box user's data to another user has no impact on data in Lumos. This can only be executed when choosing the "Deprovision" option during Offboarding, or when creating an Inactivity Workflow. See these articles:

• 📄 Offboarding Employees in Lumos

• 📄 Creating An Inactivity Workflow

In Box, this action transfers the user's Box content to the Box user you specify in Lumos.

For this to execute successfully in Box, the user to whom data is moving must have access to Relay or Relay Lite and have access to the files and folders involved in the workflows being transferred.

The Box transfer data API runs synchronously, so it may take a long time. Lumos times out after 5 seconds, but the request will still run to completion (success or failure) on the Box side.

Your Box admins receive an email if the data transfer is successful, but will not if there's an error that happens during the transfer.

Box API endpoint: https://developer.box.com/reference/put-users-id-folders-0/

Useful links

Box API documentation