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 Nutshell connector uses the following default correlation and object configurations.
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 |
Default Account Attributes
The Nutshell 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 |
|---|---|
| modifiedTimemodifiedTime | Timestamp when the user record was last modified |
| isEnabled | Indicates whether the user account is enabled |
| name | Full name of the userTimestamp when the user record was last modified |
| isEnabled | Indicates whether the user account is enabled |
| name | Full name of the user |
| id | Unique identifier for the user |
| isAdministrator | Indicates whether the user has administrative privileges |
| isAgent | The isAgent field is a boolean flag (true or false) that indicates whether a user is configured as an agent in Nutshell |
| isViewingRestricted | A boolean flag (true or false) that indicates whether a user’s access to data is restricted by viewing scope, such as being limited to their own data or team-specific data |
| canAccessEmailMarketing | This flag indicates whether a user has the permission to access and manage email marketing features in Nutshell |
| isHiddenFromFilters | indicates whether the person should be excluded from appearing in saved filters, reports, or general searches. |
| agentStatus | agentStatus represents the current state of an Agent user (mainly for organizations using Nutshell’s phone or chat integrations) |
| emails | List of email addresses associated with the user |
| teams | teams refers to the groups that a user (agent) belongs to |
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 Nutshell 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 | ID (e.g., "4-teams", "12-teams") is a unique identifier assigned by Nutshell to each team in your account |
| name | name in teams is simply the display name of the team |
| numUsers | numUsers in teams shows the total number of users (members) assigned to that team |
| modifiedTime | The timestamp (in Unix epoch format, seconds since Jan 1, 1970 UTC) representing the last time the team details were updated |