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 EspoCRM 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 EspoCRM 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 |
|---|---|
| createdByName | Name of the user who created the record |
| modifiedAt | Timestamp of user modification |
| type | Type of the user |
| isActive | Indicates if the user is active |
| createdAt | Timestamp of user creation |
| emailAddress | Primary email address of the user |
| modifiedById | Unique ID of the last user to edit this record |
| id | Unique ID for the user |
| defaultTeamId | Unique ID of the user’s default team |
| createdById | Unique ID of the user who created this record |
| firstName | First name of the user |
| phoneNumber | Phone number of the user |
| workingTimeCalendarId | Unique ID of the working time calendar assigned to the user |
| name | Full name of the user |
| teamId (entitlement) | List of team IDs associated with the user |
| lastName | Last name of the user |
| salutationName | Salutation/prefix for the user |
| gender | Gender of the user |
| defaultTeamName | Name of the user’s default team |
| title | Job title of the user |
| modifiedByName | Name of the last user to edit this record |
| avatarId | Unique ID of the user’s avatar |
| userName | Username for system login |
| roles (entitlement) | Roles of the user |
| deleted | User deleted (Y/N) |
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 Teams Attributes
| Attribute Name | Description |
|---|---|
| teamId | Unique ID for the team |
| teamName | Name of the team |
| createdAt | Date and time of team creation |
| positionList | List of positions within the team |
| modifiedAt | Date and time of team modification |
| deleted | Team deleted (Y/N) |