Configure Box Enterprise auto-provisioning

As an administrator, once you've set up SSO with Box® Enterprise your next step is to set up automated user provisioning so that any identities you create, modify, or delete in G Suite are automatically reflected in Box Enterprise.

Set up auto-provisioning for Box Enterprise
  1. Sign in to your Google Admin console.

    Sign in using your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Appsand thenSAML apps.
  3. Open the Box application.
  4. In the Auto-provisioning section, click Configure auto-provisioning.
  5. Click Authorize.

    Box opens in the same tab and you're prompted for authorization. If you haven't signed into your Box administrator account before clicking Authorize, you're prompted to sign in.

    Important: You might have to reauthorize if the admin password for Box changes. Changing the admin password will cause the original authorization to be revoked.

    If Box is configured to block unpublished applications, follow these steps:

    1. Sign in to the Box Admin Console.
    2. Click Admin Console.
    3. Click the Settings icon.
    4. Click Business Settings or Enterprise Settings.
    5. In the banner menu, choose Apps.
    6. In the Applications Settings section, if Unpublished apps is checked, enter this API Key in the entry field: av79ru9rj0082v4efu5wciehe9qwojvu.
    7. Click Save.
  6. Verify that all mandatory Box attributes (those marked with an *) are mapped to Google Cloud Directory attributes. If not, click the Down arrow "" and map to the appropriate attribute.
  7. Click Continue.
  8.  (Optional) Restrict provisioning to specific groups:
    1. Enter all or part of a group name in the Search groups field.
      A list of available groups appears. Select a group to add it and open a new search field.
    2. If necessary, add more groups and choose a scope. 
    3. To remove any group you added, click  next to it.
  9. Once you’re done, click Continue.
  10. Choose how long deprovisioning actions should be delayed before taking effect. You can set the time to: within 24 hours or after one, 7, or 21 days. Select at least one of these options:
    • When an app is turned off for the user, suspend their account, hard delete their account, or both, after [number of days].
    • When a user is suspended on Google, suspend their account, hard delete their account, or both, after [number of days].
    • When a user is deleted from Google, suspend their account, hard delete their account, or both, after [number of days].

    Tip: Always set more time before hard deleting a user's account than for suspending a user's account.

  11. Click Finish.
  12. In the Auto-provisioning section, click the activation slider.

    Note: The activation slider is disabled if Box isn’t turned on for any users. Click User access and turn the app on to enable the slider.

  13. In the confirmation dialog box, click Turn on.
Display auto-provisioning

Once provisioning is on, Google starts collecting usage information. You'll see the usage information in the Auto-provisioning section. There won't be any numbers next to the event names until you enable provisioning.

The following event names provide the usage information for the last 30 days:

  • Users created
  • Users suspended
  • Users deleted
  • Failures

For more information, see Monitor automated user provisioning.

Edit provisioning scope

You may want to restrict the scope of provisioning to members of groups you define. 

  1. Sign in to your Google Admin console.

    Sign in using your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Appsand thenSAML apps.
  3. Open the Box application.
  4. Click the Auto-provisioning section to open the settings page.
  5. Under Provisioning scope, click Edit.
  6. Enter all or part of a group name in the Search groups field. A list of available groups appears.
    1. Select a group to add it and open a new search field.
    2. If necessary, add more groups and choose a scope. 
    3. To remove any group you added, click  next to it.
  7. Once you’re done, click Update.

The next time you edit provisioning scope, the groups you added appear in the Provisioning scope window. If you turned on the Box application for a set of organizational units, the provisioning scope is restricted to those users in the added groups who are also members of those organizations.

Deactivate auto-provisioning

To disable auto-provisioning for the Box application without losing all the configuration information:

  1. Sign in to your Google Admin console.

    Sign in using your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Appsand thenSAML apps.
  3. Open the Box application.
  4. Do one of the following:
    • In the Auto-provisioning section, click the activation slider.
    • Click the Auto-provisioning section to open the settings page, then click Statusand thenTurn off.
  5. In the confirmation dialog box, click Turn off
Define deprovisioning timeframes

To define how long deprovisioning actions should be delayed before taking effect:

  1. Sign in to your Google Admin console.

    Sign in using your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Appsand thenSAML apps.
  3. Open the Box application.
  4. Click the Auto-provisioning section to open the settings page.
  5. Under Deprovisioning, click Edit.
  6. Choose how long deprovisioning actions should be delayed before taking effect. The amount of time before deprovisioning takes effect can be set to: within 24 hours or after one, 7, or 21 days. Select at least one of these options:
    • When an app is turned off for the user, suspend their account, hard delete their account, or both, after [number of days].
    • When a user is suspended on Google, suspend their account, hard delete their account, or both, after [number of days].
    • When a user is deleted from Google, suspend their account, hard delete their account, or both, after [number of days].

    Tip: Always set more time before hard deleting a user's account than for suspending a user's account.

  7. Click Update to save your edited deprovisioning configuration.
Remove auto-provisioning

To disable auto-provisioning for the Box application and remove all the configuration information:

  1. Sign in to your Google Admin console.

    Sign in using your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Appsand thenSAML apps.
  3. Open the Box application.
  4. Click the Auto-provisioning section to open the settings page.
  5. Under Delete configuration, click Delete.
  6. Click Delete to both deactivate auto-provisioning and remove all the configuration information.
    Existing users on Box will not be deprovisioned.
Important: If automatic provisioning stops and you need to reauthorize the application

If the admin password for Box has changed, automatic provisioning will stop working. In this case, the original authorization is revoked by Box, and you must reauthorize automatic provisioning.

  1. Sign in to your Google Admin console.

    Sign in using your administrator account (does not end in @gmail.com).

  2. From the Admin console Home page, go to Appsand thenSAML apps.
  3. Click the Box application.
  4. Click the Auto-provisioning section to open the settings page.
  5. Under App authorization, click Reauthorize.
  6. Click Re-authorize.

    If you haven't recently signed in to Box, you may need to sign in during reauthorization.

After reauthorization completes, you're returned to the Auto-provisioning settings page in the Admin console.

Note: Your third-party application might revoke authorization for reasons other than the admin password changing. These reasons can include account inactivity, for example. Check with the documentation for the third-party application for scenarios in which authorization can be revoked.

Was this helpful?
How can we improve it?