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 Breathe 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 Breathe 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 employee (Account ID) |
| first_name | First name of the employee (Account Name) |
| last_name | Last name of the employee |
| Email address of the employee | |
| gender | Gender of the employee |
| date_of_birth | Date of birth of the employee |
| age | Age of the employee |
| department_id | Unique department identifier for the employee (Entitlement) |
| full_or_part_time | Indicates whether the employee works full-time or part-time |
| employment_status | Current employment status of the employee |
| created_at | Timestamp when the employee record was created |
| updated_at | Timestamp when the employee record was updated |
| salary_id | Unique identifier for employee salary and compensation information |
| salary_amount | Employee's salary amount |
| address_line_1 | First line of employee address |
| address_line_2 | Second line of employee address |
| postcode | Postal code of the employee |
| job_title | Job title of the employee |
| address_city | City of employee address |
| address_county | County of the employee address |
| address_country | Country of employee address |
| personal_mobile | Personal mobile number of the employee |
| work_mobile | Work mobile number of the employee |
| person_type | Role classification of the individual (for example, Employee, Contractor, Volunteer) |
| contract_type | Type of employment contract for the employee |
| marital_status | Marital status of the employee |
| nationality | Nationality of the employee |
| location_id | Work location ID of the employee |
| notice_period | Required notice period for employee termination |
| bank_name | Bank name of the employee |
| bank_branch | Bank branch name for the employee |
| account_number | Bank account number used for payroll/salary payments |
| sort_code | Bank sort code used for payroll/salary payments (UK-specific) |
| account_id | Internal identifier for the employee's linked bank account record |
| employee_ref | Employee reference code used internally by HR teams |
| working_pattern_id | Unique identifier for the employee's working pattern |
| working_pattern_name | Name of the employee's working pattern |
| weekly_total_hours | Number of weekly working hours of the employee |
| hr | HR assigned to the particular employee |
| uuid | Globally unique identifier (UUID) for the employee |
| hr_partner_id | Identifier linking the employee to their assigned HR Partner in Breathe HR |
| home_telephone | Home telephone number of the employee |
| job_start_date | Job start date for the employee |
| join_date | Joining date of the employee |
| division_id | Division identifier for the employee |
| division_name | Name of the division the employee belongs to |
| is_line_manager | Indicates if the employee is a line manager (true/false) |
| length_of_service_in_months | Number of months the employee has served in the organization |
| probation_date | Date when the employee's probation period is due to end or be reviewed |
| leaving_date | Leaving date for the employee |
| location_name | Work location of the employee |
| remuneration_currency_id | Unique identifier for the remuneration currency |
| remuneration_currency_code | Code for the remuneration currency |
| remuneration_currency_description | Description of the remuneration currency |
| facebook_url | Facebook account link for the employee |
| linkedin_url | LinkedIn account link for the employee |
| twitter_url | Twitter account link for the employee |
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 (Department) Attributes
The Breathe 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 |
|---|---|
| department_id | Unique identifier for the particular department |
| department_name | Name of the particular department |
| created_at | Timestamp when the department was created |
| updated_at | Timestamp when the department was updated |