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 BambooHR connector uses the following default correlation and object configurations.
Default Correlation Configuration
Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements.
You can customize the correlation configuration. Refer to Assigning Source Accounts to Identities for more information.
When you first create the BambooHR source, the default correlation mapping is:
| Account Attribute | Operation | Identity Attribute |
|---|---|---|
| Equals | Work Email (email) | |
| displayName | Equals | SailPoint User Name (uid) |
| firstNameLastName | Equals | Name |
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 Attributes
The BambooHR 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 | The user's unique ID |
| firstName | The user's first name |
| middleName | The user's middle name |
| lastName | The user's last name |
| preferredName | The user's preferred name |
| displayName | The user's display name |
| jobInformationJobTitle | The user's job title |
| workPhone | The user's work phone number |
| mobilePhone | The user's mobile phone number |
| The user's work email address | |
| jobInformationDepartment | The user's department |
| jobInformationLocation | The user's location |
| jobInformationDivision | The user's division |
| employeePronouns | The user's preferred pronoun identifier |
| workExtension | The user's work phone extension |
| supervisorName | The user's supervisor |
| firstNameLastName | The user's full name |
| employeeNumber | The user's employee number |
| status | The user's active status |
| acaStatus | The user's account status category |
| employmentStatus | History of the user's employment status. For example, Full Time, Terminated, etc. |
| gender | The user's gender |
| maritalStatus | The user's marital status |
| workPhoneExt | The user's work phone number and extension |
| hireDate | The user's hire date |
| originalHireDate | The user's original hire date |
| terminationDate | The user's termination date |
| supervisorId | The user's supervisor's ID |
| supervisorEId | The user's supervisor's employee ID |
| supervisorEmail | The user's supervisor's email address |
| createdByUserId | ID for the user who created this user |
| addressLineOne | The user's street address |
| addressLineTwo | Apartment number, house number, etc. |
| city | The user's city |
| country | The user's country |
Custom Attributes
Configure the connector to include custom attributes from the source in account aggregation processes. To include additional custom attributes in the account aggregation processes, add the attribute name to the account schema exactly as it is configured in the source schema.
Note
Connect to the following API to get the exact field name from the source, and to check the response name for the custom attribute.
GET https://api.bamboohr.com/api/gateway.php/{CUST_ORG}/v1/datasets/employee/fields
Documentation Feedback
Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.