# SailPoint BambooHR Connector Documentation > BambooHR Connector Documentation # Documentation # Connecting SailPoint and BambooHR To connect SailPoint with BambooHR, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Configure**. 5. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 6. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 7. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 8. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 9. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](). 10. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Base Configuration Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary. 1. Enter a unique name and description for the source. 2. In the **Source Owner** dropdown list, select the identity that owns this source. - To find a source owner, begin entering their name. 3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 4. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 5. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](). 6. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default. - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system. - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source. 7. Select **Save**. ## Connection Settings The following information is required for SailPoint to connect and interact with BambooHR. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Select **Connection Settings** from the menu. 2. Enter the **Company Domain**. BambooHR uses following as a base url: `https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1` 3. Enter the **API Key** that was generated in the in the BambooHR system. 4. Select **Save**. ## Review and Test Perform a test to confirm the connection to SailPoint. 1. Go to **Review and Test**. 2. Confirm that the entries in each field are correct. If you note any mistakes, return to the section and make corrections. 3. Select **Test Connection**. ## SailPoint Application Onboarding SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface. For more information, refer to [Application Onboarding]() in the SailPoint SaaS documentation. # Integrating SailPoint with BambooHR BambooHR is Human Resources (HR) management software that brings a large set of features and functionality. The BambooHR source manages Employees from BambooHR. This guide is designed to give specific information about the requirements and fields needed to successfully configure an instance of the BambooHR source. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The BambooHR source supports the following features: - Aggregation of Accounts (Both Active and Inactive accounts) - Get Account - Provisioning - Update Account The update operation is applicable to the following attributes: - `displayName` - `firstName` - `lastName` - `preferredName` - `jobTitle` - `workPhone` - `mobilePhone` - `workEmail` - `department` - `location` - `division` - `pronouns` - `workPhoneExtension` ## Prerequisites The Bamboo HR application supports **API Key** authentication. To connect with BambooHR, you must first generate an **API Key** in the BambooHR system. You will then use this key for authentication and authorization. No additional permissions are required to generate API Keys. Full Admins have the access to manage accounts. # 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](<#default-account-schema>) 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 | | --- | --- | --- | | email | 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 | | email | 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` # Troubleshooting If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support. For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information: - [SailPoint Identity Services Documentation]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## Debug Logs For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings](). ## Account aggregation fails with an HTTP 400 error Account aggregation processes fail with the following error: `HTTP 400 ERR_BAD_REQUEST` **Resolution**: Confirm that all account schema attribute names are configured as documented. The attribute names are case sensitive. For more information, refer to [Default Account Attributes]().