# SailPoint Box SaaS Connector Documentation > Box SaaS Connector Documentation # Documentation # Connecting SailPoint and Box SaaS To connect SailPoint with Box, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Configure**. 5. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 6. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 7. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 8. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 9. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](). 10. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Base Configuration Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary. 1. Enter a unique name and description for the source. 2. In the **Source Owner** dropdown list, select the identity that owns this source. - To find a source owner, begin entering their name. 3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 4. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 5. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](). 6. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default. - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system. - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source. 7. Select **Save**. ## Connection Settings Provide the information required to connect and interact with the source. The Box SaaS connector supports the following authentication types: - OAuth 2.0 with JWT Key Pair Authentication - Client Credentials Grant For more information on configuring this feature, refer to the [Prerequisites]() topic. ### Key Pair Authentication > [!NOTE] > > **Screenshot** > > [![Key Pair Authentication]()]() To configure connection settings, complete the following: 1. Select **Key Pair Authentication** as the **Authentication Type**. 2. Enter the Box **Enterprise ID** for a token specific to an enterprise. 3. Enter the Box **Public Key ID** generated by Box and provided upon submission of a Public Key. 4. Enter the **Client ID** and **Client Secret** for the source. 5. Enter the **Private Key** text used for encrypting the JWT assertion and the **Private Key Password** used to decrypt the private key. 6. Select **Save**. ### Client Credentials > [!NOTE] > > **Screenshot** > > [![Client Credentials]()]() To configure connection settings, complete the following: 1. Select **Client Credentials** as the **Authentication Type**. 2. Enter the Box **Enterprise ID** for a token specific to an enterprise. 3. Enter the **Client ID** and **Client Secret** for the source. 4. Select **Save**. ## Aggregation Settings Configure settings related to aggregation. For more information about aggregation, refer to [Loading Account Data](). > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() To configure your aggregation settings, complete the following: 1. (Optional) Select **Delta Aggregation** to enable delta aggregation. Delta aggregation is based on the event type. For more information on event type, refer to [Enterprise Events](). By default, the following event types are supported: - DELETE\_USER - NEW\_USER - EDIT\_USER - GROUP\_ADD\_USER - GROUP\_REMOVE\_USER To add another event type or remove ones from the above list, set the `deltaUserEventsList` attribute using the SailPoint REST API. For example, you could add `SAMPLE_EVENT_TYPE` to the list. > **Note** > > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. 2. (Optional) Select **Disable Group Membership** to disable the fetching of group members during account aggregation. 3. (Optional) Enter the **Page Size** to specify the number of records returned per page. The default is 100. 4. Select **Save**. ## Activity Insights Settings SailPoint pulls in activity data in the form of events like user logins, password changes, and content updates within the application. You can view an identity’s activity data within an application to discover trends for that user. > [!IMPORTANT] > > Contact your SailPoint Customer Success Manager (CSM) for more information on Activity Insights. For more information on utilizing activity data, refer to [Activity Insights](). Activity Insights Settings allows you to gather account information and activity data from Box. To enable Activity Insights for the Box application, refer to [Prerequisites]() for more information. To configure Activity Insights, complete the following: > [!NOTE] > > **Screenshot** > > [![Activity Insights Settings]()]() 1. Go to **Activity Insights Settings**. 2. Select **Enable Activity Insights** to view access to data insights on source and application activity such as logins and other app-specific events. 3. Select **Save**. ## Review and Test Perform a test to confirm the connection to SailPoint. 1. Go to **Review and Test**. 2. Confirm that the entries in each field are correct. If you note any mistakes, return to the section and make corrections. 3. Select **Test Connection**. ## SailPoint Application Onboarding SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface. For more information, refer to [Application Onboarding]() in the SailPoint SaaS documentation. # Integrating SailPoint with Box SaaS The SailPoint Box SaaS connector is used for securely storing, managing and collaborating with users. It supports aggregation, provisioning, and user management for governance. For more information, refer to [Supported Features](<#supported-features>). If you have user accounts in Box that you want to load into SailPoint, you can create a direct connect source and load that data into your system. To manage that data, either create an identity profile based on the source or verify that the accounts you load are correlated to an existing identity. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features SailPoint provides support for the following features: ### Account Management - Manage Box users as Accounts - Aggregation, Delta Aggregation, and Refresh Accounts - Create and update Accounts - Enable and disable Accounts - Add and remove Entitlements - Delete Accounts ### Account - Group Management - Manage Box Groups as Account-Groups ### Activity Insights Activity Insights supports activity from Box and its associated accounts. This allows you to gather account information and activity data from Box. > [!IMPORTANT] > > Contact your SailPoint Customer Success Manager (CSM) for more information on Activity Insights. For more information on configuring Activity Insights, refer to Activity Insights Settings. For more information on features, see [Source Features](). ## Supported Managed Systems The SailPoint Box SaaS connector supports the following managed system: - BOX API Version 2.0 supported by Box Server ## Prerequisites - A working instance of a Box source for which a domain name, a client ID, and a client secret have already been generated. - You must have access to a Box account with the following permissions: - Create and retrieve users - Enterprise user memberships - Box groups ### Authentication The Box SaaS connector supports JWT authentication (server authentication) and Client Credentials authentication on the Box SaaS connector configuration page. #### OAuth 2.0 with JWT (Server Authentication) #### For Preexisting Connectors If you want to change the authentication method on an existing Box source, complete the following steps: 1. Manually remove the `customAttributesFileLocation` entry key from source XML or set the value for this entry to blank (" ") to access the new user interface on your source. > **Note** > > If the entry key mentioned above is not removed, by default, the connecter refers to the file that contains the key and value pair required for JWT. 2. Enter the parameter values on the **Connection Settings** page. #### For New Connectors > [!NOTE] > > You must use the OpenSSL tool to generate a new private/public key for the Box connector. You should not use a public/private key that you can generate on the managed target Box system. - The Box SaaS connector application must support **OAuth 2.0 with JWT (Server Authentication)**. Complete the following steps to provide support for OAuth 2.0 with JWT: 1. Go to the [Box Developers Console]() then select your application and the configuration. 2. Under **Authentication Method** select **OAuth 2.0 with JWT (Server Authentication)**. 3. Under **Add and Manage Public Keys** section, select **Add a Public Key**. 4. Upload the generated public key (Public Key ID). - You must generate the public / private key pair using the following commands. These commands can be executed on both Windows and Linux systems. Private Key ```text openssl genrsa -aes256 -out private_key.pem 2048 ``` > **Note** > > The password is set while generating the private key. Public Key ```text openssl rsa -pubout -in private_key.pem -out public_key.pem ``` This command provides the keys with 256-bit encryption. If encryption is set to more than 128-bits, download the JCE Unlimited Strength .zip file from [Oracle]() for the JRE version that you are using and extract the following .jar files of your JRE: - local\_policy.jar - US\_export\_policy.jar > **Important** > > Replace these .jar files in your JRE (jre\_directory/lib/security). OpenSSL Use the following command to generate a private key for legacy OpenSSL versions, such as 0.9.8, 1.0.2, 1.1.0, or 1.1.1. ```text openssl genrsa -aes256 -out private_key.pem 2048 ``` Use the following command to generate a private key for OpenSSL version 3.0 and later. ```text openssl genrsa -aes256 -out private_key.pem -traditional ``` #### Client Credentials Grant (Server Authentication) The Box SaaS connector application must support **Client Credentials Grant (Server Authentication)**. Complete the following steps to provide support for Client Credentials Grant: 1. Go to the [Box Developers Console]() then select your application and the configuration. 2. Under **Authentication Method** select **Client Credentials Grant (Server Authentication)**. ## Required Permissions The administrator should be able to create and retrieve enterprise users, enterprise user memberships, and Box groups. The Box application created on the Box system must have the **Manage an enterprise** scope selected as the permission. > [!NOTE] > > You must always reauthorize the connector after modifying permissions on the Box managed system for the changes to take effect. ### For Activity Insights An administrator requires the following additional permissions to utilize the Activity Insights: | Scope | Description | | --- | --- | | Manage groups | Gives the application permission to manage an enterprise's group. | | Manage enterprise properties | Gives the application permission to view the enterprise event stream. | | Admin can make calls on behalf of Users | Allows the application to make API calls on behalf of users using the As-User header. | | Manage app users | Gives the application permission to manage standard App users. | | Manage users | Gives the application permission to manage standard (managed) Box users. | For more information on configuring Activity Insights, refer to [Activity Insights Settings](). # Machine Account Attributes Machine account attributes are used in provisioning configurations for machine accounts. After you have [created the required machine account subtypes](), you can use the machine account attributes to provision machine accounts in your SailPoint tenant. Refer to [Machine Identity Security Overview]() for more information. ## Machine Account Provisioning Attributes | Field (name) | Type | Required | Notes | | --- | --- | --- | --- | | name | string | Yes | Display name of the machine account. | | is\_platform\_access\_only | boolean | Yes | This flag is required to create the account as an App User rather than a standard human user. Default static value is true. | | space\_amount | long | No | Space allocated to the user. Default static value is 5. | | unlimited | string | No | Default static value is No. | | status | boolean | No | Indicates if the user is enabled or disabled. Default value is disable. | # Provisioning The Box SaaS connector supports provisioning, allowing you to create and manage accounts and entitlements in Box directly from SailPoint. **Prerequisite:** Your system is configured for provisioning. When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*. When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment. For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account. > [!IMPORTANT] > > This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail. ## Default Create Account Attributes The following generators create the information required for a new Box SaaS account. You may need to edit the contents. > [!NOTE] > > Parameters marked with an asterisk (\*) are mandatory. | Account Attribute | Generator | Description | | --- | --- | --- | | name\* | Display Name | Name for the enterprise user. | | login\* | Work Email | Login ID of the enterprise user. | | space\_amount | Static | Space to be allocated to the user in gigabytes. | | unlimited | Static | Unlimited space amount. | | role | Static | Box user role as co-administrator/user. | | status | Disable | Enabled or disabled status for the user. | ## Provision Tracking Codes Before you can provision tracking codes to the Box source, you must add them to the account schema. For more information, refer to [Custom Attributes](). The Box SaaS connector supports provisioning of tracking codes for the following operations: - Create - Update > [!IMPORTANT] > > The provisioning process will fail if you do not follow these rules: > > - Use only the format given in these instructions to add the tracking code to the account schema: > > ```text > tracking_code. > ``` > - The tracking code's values and labels are both case-sensitive. > - The tracking code label should be exactly as it is in the managed system. # Schema Reference The application schema is used to configure the objects returned from a connector. > [!NOTE] > > - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas]() for more information. > - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified. The Box SaaS connector uses the following default correlation and object configurations. ## Default Correlation Configuration Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements. You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities]() for more information. When you first create the Box SaaS source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | login | Equals | Work Email | | user\_id | Equals | Name | | name | Equals | Display Name | ## Default Account Schema Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location. The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas]() for more information. ### Default Account ID SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*. > [!CAUTION] > > Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts. > > To resolve issues caused by changing account IDs, reconfigure them to their default values. The following table lists the default account IDs for this connector: | Account ID | Schema Object Type | | --- | --- | | id | Account | | group\_id | Group | ### Default Account Attributes The Box SaaS connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. | Attribute Name | Description | | --- | --- | | id | User ID as assigned by Box server. This is an Identity Attribute which must not be changed. | | name | Name of the enterprise user. | | login | Email ID used to login. | | role | User role as co-administrator/user. | | memberof | Member of. | | space\_amount | Space allocated to the user in gigabytes. | | max\_upload\_size | The maximum individual file size in bytes this user can have. | | is\_sync\_enabled | Indicates whether the user can use synchronization as Yes/No. | | job\_title | The user's job title displayed on their profile page. | | phone | The user's phone number displayed on their profile page. | | address | The user's address. | | language | Two-letter representation of user language. For example, `en` for English. | | status | User is enabled or disabled. | | can\_see\_managed\_users | Whether the user can see other users in the enterprise in their contact lists as Yes/No. | | is\_exempt\_from\_device\_limits | Whether to exempt this user from Enterprise device limits as Yes/No. | | is\_exempt\_from\_login\_verification | Whether or not this user must use two-factor authentication. | | is\_platform\_access\_only | Whether User is Application User or not. This property is used to differentiate between human and App Users. | | enterprise | The user's enterprise. | ### Custom Attributes Configure the connector to include custom attributes from the source in account aggregation processes. To include additional custom attributes in the account aggregation processes, add the attribute name to the account schema exactly as it is configured in the source schema. The Box SaaS connector supports aggregating tracking codes as custom account attributes. #### View and Copy Tracking Codes in the Box System To view and copy your existing tracking codes: 1. In the Box system, go to the **Admin** console. 2. Go to **Enterprises \> User Settings \> User Tracking Codes**. The system displays a list of your existing tracking codes. 3. Copy the tracking codes you want to include in aggregation. These are required for configuration in the SailPoint source configuration. #### Add Tracking Codes to Aggregation Add the tracking code copied from the Box system to the account schema. Adding the tracking code to the account schema enables the connector to include it during aggregation processes. 1. In the Box source configuration, go to **Account Management** and then select **Account Schema**. 2. Select **Add New Attribute**. 3. In the **Name** field, enter the name of the tracking code copied from Box in the following format. ```text tracking_code. ``` For example: ```text tracking_code.Country ``` > **Important** > > The aggregation process will not include the tracking codes if you do not follow these rules: > > - Use only the format given in these instructions to add the tracking code to the account schema. > - The tracking code's values and labels are both case-sensitive. > - The tracking code label should be exactly as it is in the managed system. 4. Select **Save**. ## Default Entitlement Attributes Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements]() for more information. > [!CAUTION] > > Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations. ### Default Group Attributes The Box SaaS connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups. | Attribute Name | Description | | --- | --- | | id | Group ID as assigned by Box server. This is an Identity Attribute which must not be changed. | | name | Group name. | Box group membership and group access: Whenever an entitlement is requested for a user, by default the Box connector adds a user into a group with `member` as the access value. This is true for all entitlement requests. > [!NOTE] > > To disable the fetching of group members in account aggregation, set the value of the following attribute to true: > > ```text > > ``` > > By default the value of this attribute is `false`. # Troubleshooting If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support. For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information: - [SailPoint Identity Services Documentation]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## Debug Logs For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings](). ## During Enable/Disable of Accounts the Following Error Message Is Displayed ```text openconnector.ConnectorException: api.box.com ``` **Resolution**: Verify network connections. ## IP Address Not Allowed **Resolution**: Add below key in app.xml file ```xml true ```