> For AI agents: [llms.txt](https://docs.trustedauth.com/llms.txt) provides a Markdown index of this documentation.

# Box

Box is a secure cloud content management and file managing service (see <https://www.box.com/en-ca/home>). You can configure your Box account to Single Sign-On (SSO) through Identity as a Service. More information on configuring Box for SSO with Identity as a Service as an Identity Provider can be found at the [Box Community Website](https://community.box.com/t5/For-Admins/Single-Sign-On-SSO-with-Box-For-Administrators/ta-p/1263#subwyidp).

note

This procedure was tested using previous versions of Identity as a Service and Box. Other versions of Box may require integration and configuration steps that differ from those documented in this procedure. For newer versions of Box, use this procedure as a starting point for integrating Box. In the event of other issues, contact <support@entrust.com> for assistance.

To integrate Box with Identity as a Service you must do the following:

## Step 1: Create a custom user attribute for Box

Create a custom user attribute for Box in Identity as a Service

You need to create custom user attribute to fully integrate Box and Identity as a Service.

1. Click Menu icon **>** **Members > Attributes**. The **User Attributes List** page appears.
2. Under **Custom User Attributes**, click **Plus icon**. The **Add User Attribute** dialog box appears..
3. Enter **Box ID** as the **User Attribute Name** for the custom user attribute.
4. Optional: Check **Required** to make the user attribute mandatory.
5. Click **Add** to create the attribute. The attribute now appears in the list of **Custom User Attributes**.

## Step 2: Add Box to Identity as a Service

Add Box application to Identity as a Service

1. Log into your Identity as a Service administrator account.

2. Click Menu icon **>** **Security > Applications**. The **Applications** **Lists** page appears.

3. Click **Add**. The **Select an Application Template** page appears.

4. Do one of the following:

   - Select **SAML Cloud Integrations** from the search drop-down list and scroll to find the application you want to add to IDaaS.
   - In the **Search bar**, enter a search option to filter for the application you want to add to IDaaS.

5. Click **Box**. The **Add Box** page appears.

6. Enter an **Application Name**.

7. Enter an **Application Description**.

8. Optional. Add a custom application logo.

   1. Click Plus icon next to **Application Logo**. The **Upload Logo** dialog box appears.
   2. Click Upload icon to select an image file to upload.
   3. Browse to select your file and click **Open**. The **Upload Logo** dialog box reappears showing your selected image.
   4. If required, resize your image.
   5. Click **OK**.

9. Select the **Authentication Flow** that appears to users during login.

10. Click **Next**. The **General** page appears.

11. If available, use the **Upload Metadata XML** file option to auto-populate the following fields, if available in the file:

    - Default Assertion Consumer Service URL
    - Alternative Assertion Consumer URLs
    - Service Provider Entity ID (Issuer)
    - Single Logout Service URL
    - SAML Signing Certificate
    - SAML NameID Encoding Format
    - SAML Signature Algorithm
    1. Click Upload icon to the **Upload Metadata XML** and browse to the location of the metadata file you downloaded. The **Metadata Configuration** dialog box appears.
    2. If required, click **Merge with existing values** to merge new values with existing values for Alternative Assertion Consumer Services URLs and SAML attribute names.
    3. Click **Save**.

12. Enter the **SAML Session Timeout** to the time when the SAML Assertion times out. The maximum is 720 minutes.

13. Enter the **Max Authentication Age (seconds)** to set the maximum amount of time that can elapse before a user is required to reauthenticate during a new login attempt. This applies for both SP-initiated and IDP-initiated login. Set this field to -1 to disable this feature.

14. If you do not have a metadata file, use the information provided in the next steps to populate the fields.

15. Enter the **Default** **Assertion Consumer Service URL** for the application.

    > <https://sso.services.box.net/sp/Identity> as a Service.saml2

16. Enter the **Service Provider Entity ID (Issuer)** that is used by Identity as a Service to identify your application.

    > box.net

17. Leave the **Single Logout Service URL** field blank.

18. Optional. Enter the **SAML Username Parameter Name** used to identity the user ID being requested for authentication. The user ID can then be passed as a parameter, for example, Username=jdoe.

19. From the **SAML Name ID Attribute** drop-down list, select **Box Id** as the user attribute that will be used to uniquely identity a user to both Identity as a Service and your application.

note
If the user's email address in Identity as a Service matches exactly the user's email address in Box, then you can select **Email** as the SAML Name ID Attribute.

20. **For the** **SAML NameID Encoding Format, s**elect **email**.

21. For **SAML Response Signature Algorithm,** select the signing algorithm you want Identity as a Service to use to sign the SAML response/assertion. The type of algorithm you select depends on the requirements of the application being configured.

22. Select the **SAML Signing Certificate** from the drop-down list.

23. Optional: Select **Sign complete SAML response** to ensure the message integrity of the SAML response sent to the application during authentication.

24. Optional: Select **Respond Immediately for Unsuccessful Responses** to return to the application immediately after a login failure, rather than allow user to try again with a different userID.

25. Deselect **Enable Go Back Button** if you do not want users to be able to go back to the Box login page to log in.

26. Select **Show Default Assertion Consumer URL Service in the My Profile**. When selected, the Default Assertion Consumer URL appears in a user's My Profile page in addition to relay states and Alternative Assertion Consumer URLs.

27. Optional: Select **Encrypt SAML Assertion**. When selected the SAML Assertion is also encrypted. If you select this option, do the following:

    1. From the **Encryption Method for Key** drop-down list, select either **RSA Version 1.5** or **RSA-OAEP**. RSA Version 1.5 is the default.

    2. From the **Encryption Method for Data** drop-down list, select the encryption method used to encrypt data. The options are:

       - AES-256 (default)
       - AES-128
       - AES-192
       - Triple DES

    3. In the **Encryption Certificate** field, upload the encryption certificate file.

    note
    The **Subject Domain Name** and **Certificate Expiry Date** values are populated with values from the certificate once the **Encryption Certificate** is uploaded.

28. Optional. Add **Alternative Assertion Consumer Service URLs**, as follows:

    1. Click **Add**.
    2. Enter a **Name**.
    3. Enter a URL **Value**.
    4. Select **Show in My Profile** to display the Alternative Consumer Service URL in a user's My profile page.
    5. Optional. **Add an Application Logo**.
    6. Click **Add**.
    7. Repeat these steps to add more Alternative Assertion Consumer Service URLs.

29. Optional. Add a **Relay State** as follows:

    1. Under **Relay State**, click **Add**. The **Add Relay State** dialog box appears.

    2. Enter a **Name** for the relay state.

    3. Enter the **Value** for the relay state. This setting specifies the application or URL that is a user is redirected to after successful authentication.

    4. Select **Show in My Profile** to display the relay state on the user's My Profile page.

    note
    After you add relay states, you can also enable or disable them on the Add/Edit application page. Relay states apply to the Default Assertion Consumer Service URLs and not the Alternative Assertion Consumers URLs.

    5. Optional. Add a Relay State custom logo.

       1. Click Plus icon next to **Relay State Logo**. The **Upload Logo** dialog box appears.
       2. Click Upload icon to select an image file to upload.
       3. Browse to select your file and click **Open**. The **Upload Logo** dialog box reappears showing your selected image.
       4. If required, resize your image.
       5. Click **OK**.

    6. Click **Add**.

    7. Repeat these steps to add more Relay States.

30. Click **Submit**.

## Step 3: Add a resource rule

See [Create resource rules](/docs/authentication-and-security/create-and-manage-resource-rules.md).

## Step 4: Download the Metadata file from Identity as a Service

Download the Metadata file from Identity as a Service

1. In Identity as a Service, click Menu icon **>** **Security > Applications**. The **Applications List** page appears.

2. Do one of the following:

   - Click Cloud Download icon next to the application you are integrating with Identity as a Service.
   - Click Ellipsis Vertical icon next to the application you are integrating with Identity as a Service and select **SAML IDP Metadata**.

   The **SAML Application Metadata** dialog box appears.

3. **Select the certificate to include in the SAML IDP Metadata file** from the drop-down list.

4. If applicable, **Select the domain to include in the SAML IDP Metadata** file from the drop-down list.

5. Enter the **Lifetime, in days, for the SAML IDP Metadata file**. The value must be between 2 and 730.

6. Do one of the following, as required:

   - Copy the **Public Endpoint** to paste into your SAML application being used Identity Provider authentication.
   - Click **Download**.

note
If you are using multiple domains, you must download each domain's metadata file separately because the values in the metadata file vary for each domain.

## Step 5: In Box, set up single-sign on for IDaaS

Follow the instructions provided by Box to set up single sign-on for IDaaS. See for details and instructions:

<https://support.box.com/hc/en-us/articles/360043696514-Setting-Up-Single-Sign-On-SSO-for-your-Enterprise>

## Step 6: Map the user's email address in the BOX ID attribute in Identity as a Service

Add Box ID to Identity as a Service user attribute

1. Log in to your Identity as a Service account.
2. Click Menu icon **>** **Members > Users**. The **Users List** page appears.
3. Click the **User ID** for the profile you want to edit. The **User Profile** page appears.
4. Under **Attributes**, locate the one you created for Box ID.
5. On the line below, enter the user's email address that will be used to map the user's Box ID account to Identity as a Service.
6. Ensure that the email address matches exactly the email address used in Box.
7. Click **Save**.
