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 Bigin 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 Bigin 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 | Unique identifier for the user |
| firstName | First name of the user |
| lastName | Last name of the user |
| fullName | Full name of the user for display purposes |
| Email address of the user | |
| status | Current status of the user account |
| roleId (entitlement) | Unique identifier for the user's role |
| country | Country of the user's address |
| city | City of the user's address |
| state | State or province of the user's address |
| zip | Postal or ZIP code of the user's address |
| phone | Phone number of the user |
| mobile | Mobile phone number of the user |
| fax | Fax number of the user |
| alias | Alias or nickname of the user |
| signature | Email signature of the user |
| website | Website URL associated with the user |
| dob | Date of birth of the user |
| language | Preferred language of the user |
| locale | Locale setting for the user |
| countryLocale | Country-specific locale setting for the user |
| timeZone | Time zone setting for the user |
| timeFormat | Preferred time format for the user |
| dateFormat | Preferred date format for the user |
| offset | Time zone offset for the user |
| nameFormat | Format for displaying the user's name |
| decimalSeparator | Decimal separator preference for the user |
| defaultTabGroup | Default tab group setting for the user |
| microsoft | Indicates Microsoft integration status for the user |
| personalAccount | Indicates whether this is a personal account |
| isOnline | Indicates whether the user is currently online |
| confirm | Confirmation status of the user account |
| zuid | Zoho unique identifier for the user |
| createdByName | Name of the user who created this record |
| createdById | Unique identifier of the user who created this record |
| modifiedByName | Name of the user who last modified this record |
| modifiedById | Unique identifier of the user who last modified this record |
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.
| Account ID | Description |
|---|---|
| roleId | Unique identifier for the role |
| roleName | Name of the role |
| displayLabel | Display label for the role |
| description | Description of the role |
| forecastManager | Forecast manager associated with the role |
| shareWithPeers | Indicates if the role shares data with peers |
| reportingTo | Identifier of the role this role reports to |