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 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:

In the Box system, go to the Admin console.
Go to Enterprises > User Settings > User Tracking Codes.

The system displays a list of your existing tracking codes.
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.

In the Box source configuration, go to Account Management and then select Account Schema.
Select Add New Attribute.
In the Name field, enter the name of the tracking code copied from Box in the following format.
```
tracking_code.<name_from_Box_system>
```
For example:
```
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.
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:

<entry key="disable_group_membership" value="true"/>

By default the value of this attribute is false.

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.