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 Finch 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 Finch 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 UUID v4 identifier for the individual employee |
| first_name | First name of the individual employee |
| middle_name | Middle name of the individual employee |
| last_name | Last name of the individual employee |
| preferred_name | Preferred or chosen name of the individual |
| dob | Date of birth of the individual (YYYY-MM-DD) |
| gender | Gender identity of the individual, as reported |
| ethnicity | Ethnicity of the individual as reported in Finch |
| email.work | Work email address of the individual |
| email.personal | Personal email address of the individual |
| phone_number.work | Work phone number of the individual |
| phone_number.personal | Personal phone number of the individual |
| is_active | Indicates whether the individual is currently an active employee |
| employment_status | Indicates whether the employee is currently active or inactive or terminated |
| employment_type | Type of employment |
| employment_subtype | Employment subtype |
| title | Job title or position from the employment record |
| start_date | Date the employee started current employment (ISO 8601) |
| end_date | Date employment ended, null if the employee is currently active |
| department_name | Name of the department associated with the employee |
| department.name | Department name from the department.name field |
| manager.id | Unique identifier of the employee's direct manager |
| manager_id | UUID of the employee's direct manager |
| flsa_status | FLSA classification or class code of the employee |
| residence.line1 | First line of the residential address |
| residence.line2 | Second line of the residential address |
| residence.city | City of the residential address |
| residence.state | State or province of the residential address |
| residence.postal_code | Postal or ZIP code of the residential address |
| residence.country | Country of the residential address |
| work_location.line1 | First line of the work location address |
| work_location.line2 | Second line of the work location address |
| work_location.city | City of the work location |
| work_location.state | State or province of the work location |
| work_location.postal_code | Postal or ZIP code of the work location |
| work_location.country | Country of the work location |
| compensation.amount | Compensation amount from income |
| compensation.currency | ISO 4217 currency code for compensation |
| compensation.unit | Pay frequency or unit |
| compensation.effective_date | Effective date of the most recent compensation record |
| custom_fields | Custom field values from the employer payroll system |