Configuring Box as an Identity Provider

Owned by Universal Importer for Confluence
Last updated: Aug 08, 2019 by Patrick Parker

The EmpowerID SSO framework allows you to configure Box as an identity provider for the EmpowerID Web application. EmpowerID integrates with Box using the OAuth protocol to allow your users to log in to EmpowerID using their Box account.

This topic describes how to configure an IDP connection for Box and is divided into the following activities:

  • Adding the Client ID and Client Secret to the Box OAuth Connection
  • Adding MFA Points to the Box OAuth Connection
  • Adding a Login tile for Box
  • Testing the Box connection


As a prerequisite to creating an SSO Connection for Box as an Identity Provider, you must have a Box account and register the EmpowerID web application for your organization in the Box Developer site. This creates a set of values known by Box and the EmpowerID web application that allow the two to enter into a federated trust relationship. These values include the Client ID and the Client Secret (these values are generated by Box), as well as the Redirect URI (this value is entered by you to tell Box where to post the assertion of a user's identity to the EmpowerID Assertion Consumer Service). 

For specific directions on registering EmpowerID as an application in Box, see the information provided by Box at https://developer.box.com.

When registering EmpowerID in Box, use the following URL as the Callback or Return URL, replacing "FQDN_OF_YOUR_EMPOWERID_SERVER" with the FQDN or fully resolvable DNS of the EmpowerID Web server in your environment.

https://FQDN_OF_YOUR_EMPOWERID_SERVER/WebIdPForms/oauth/v2


Once the IDP Connection has been set up for Box, you can create a link similar to the one below to allow users to login to EmpowerID using Box.

https://FQDN_OF_YOUR_EMPOWERID_SERVER/WebIdPForms/Login/Portal/Box?returnUrl=%2FWebIdPForms%2F



Be sure to replace "FQDN_OF_YOUR_EMPOWERID_SERVER" with the FQDN or fully resolvable DNS of the EmpowerID Web server in your environment and "Box" with the name of the IDP connection you create for PayPal in EmpowerID.



To add the Client ID and Client Secret and to the Box OAuth Connection

  1. From the navigation sidebar of the EmpowerID Web interface, expand Single Sign-On > SSO Connections and click OAuth.
  2. From the OAuth Applications page, click the OAuth Service Provider tab and then search for Box.

  3. From the OAuth Service Provider grid, click the Box link.



  4. In the External OAuth Provider Details page that appears, click the Edit button for the specific Box connection you want to edit. By default, EmpowerID includes one connection. However, you can add as many connections for Box as your organization needs by clicking the (plus) button.



  5. In the OAuth Connection pane that appears, type the Client ID Box generated for your application in the Consumer Key field and the Secret in the Consumer Secret field.



  6. Prepend the value of the Callback Url with the FQDN of your EmpowerID Web server, using the https scheme. For example, the FQDN of the EmpowerID Web server in our environment is "sso.empoweriam.com" so the full Callback Url for our site is "https://sso.empoweriam.com/webidpforms/oauth/v2".
  7. Click Save to close the OAuth Connection pane.
  8. Optionally, add any desired MFA points to the Box application by following the below steps.


To add Level of Assurance points to the Box application

  1. From the External OAuth Providers page for Box, click the Provider Edit link at the top of the page.
  2. In the Level of Assurance (LoA) field, type the number of assurance points you want to give to users logging in with Box.



  3. Click Save.

Next, add a login tile for Box to the desired IdP Domains. This allows your users to authenticate to EmpowerID with their Box credentials. If you have not set up an IdP Domain for your environment, you can do so by following the directions in the below drop-down.


To add a login tile for Box

  1. From the navigation Sidebar, expand Single Sign-On > SSO Connections and click SSO Components.
  2. Select the IdP Domains tab and then click the link for the IdP domain for which you want to add a login tile.




  3. In the IdP Domain Details page that appears, click the External OAuth Providers tab and check the box beside Box.



  4. Click Save.

    To give users the ability to log in using their EmpowerID credentials, be sure to select EmpowerID from the SAML Identity Providers tab of the IdP Domain Details page.



To test the Box connection

  1. From the Navigation Sidebar, expand IT Shop and click Workflows.
  2. From the Workflows page, recycle the EmpowerID App Pools by clicking Recycle EmpowerID App Pools.




  3. Log out of the EmpowerID Web application and navigate your browser to the domain name you configured for the Box IdP connection.
  4. Click the Login using Box button.
  5. This redirects your browser to the Box Login for the EmpowerID web application you created in Box. Enter your Box credentials and click Authorize.




  6. Click Grant access to Box.




  7. Back in the EmpowerID Web interface, click Yes to indicate that you have an EmpowerID login.

    Users without EmpowerID Persons can request EmpowerID accounts by clicking No. This initiates the Create User Account workflow, which displays a form in the browser to allow the user to fill in the appropriate information. If a user submits the request, EmpowerID routes that request to those individuals in your environment with the ability to approve or deny the request and returns the user to the EmpowerID web login.

  8. Type your EmpowerID Login or Email in the form and click Submit. The EmpowerID Person must have a valid email address as EmpowerID sends a one-time password to that address.
  9. Check your email for the one-time password.

  10. Back in the EmpowerID Web interface, type the one-time password into the Password field of the One-Time Password Validation form and click Submit.

    Upon successful submission of the one-time password, EmpowerID logs the user in and joins the Box account to their EmpowerID Person account.


    If you have set up the user's Password Manager policy to require the user accumulate a specific number of trust points beyond those granted by the identity provider, EmpowerID will direct the user through any Multi-factor methods you have enabled on the policy until they reach the needed point threshold to log in.