# SailPoint BeyondTrust Password Safe SaaS Connector Documentation > BeyondTrust Password Safe SaaS Connector Documentation # Documentation # Connecting SailPoint and BeyondTrust Password Safe SaaS To connect SailPoint with BeyondTrust Password Safe, 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 **Actions**. 5. In the **Actions** dropdown list, select the setup method: - [**Express Setup**](<#configuring-a-source-using-express-setup>) - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started. > **Note** > > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](). For more information, contact your SailPoint Customer Service Manager. - [**Standard Setup**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup. ### Configuring a Source Using Express Setup Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data. 1. Review the directions and select **Start Express Setup**. 2. Review the pre-populated **Source Name**, **Source Owner**, and **Description**. To update, select **Edit**. > **Note** > > The source name must be unique. You can change these settings later in the source configuration. 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 in SailPoint, 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. For more information, refer to the **Connection Settings** section. 5. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation. - If you want to aggregate now, select **Aggregate**. - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**. - To see the list of aggregated source accounts, go to **Account Management \> Accounts**. - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet. ### Configuring a Source Using Standard Setup Use Standard Setup to configure the connector for full feature support. 1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 2. 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. 3. 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](). 4. (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](). 5. 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](). 6. 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 Choose the appropriate authentication type and provide the information required to connect and interact with the source. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Enter the **Host URL** of the managed system that you are connecting with. For example: `https://{yourbeyondtrustDomain}.com/scim/v2` 2. Select your **Authentication Type**: - [OAuth 2.0](<#oauth-20-authentication-type>) - [API Token](<#api-token>) ### OAuth 2.0 Authentication Type You can use OAuth 2.0 authentication where an access token is used for the connection. Access tokens are generated based on the selected grant type and a generated token can be used. The following grant types are supported. #### Client Credentials > [!NOTE] > > **Screenshot** > > [![OAuth 2.0 Client Credentials connection settings]()]() 1. Select **OAuth 2.0**. 2. From the **Grant Type** dropdown list, select **Client Credentials**. 3. Enter the **OAuth 2.0 Token URL** for generating an access token. 4. Enter the **Client ID** and **Client Secret** for OAuth 2.0 authentication. 5. (Optional) Enter the value of **Connection Timeout (In minutes)** to hold the connection. The default is 1 minute. 6. Select **Save**. #### Refresh Token > [!NOTE] > > **Screenshot** > > [![OAuth 2.0 Refresh Token connection settings]()]() 1. Select **OAuth 2.0**. 2. From the **Grant Type** dropdown list, select **Refresh Token**. 3. Enter the **OAuth 2.0 Token URL** for generating an access token. 4. Enter the **Client ID** and **Client Secret** for OAuth 2.0 authentication. 5. Enter the **Refresh Token** used to generate an access token. 6. (Optional) Enter the value of **Connection Timeout (In minutes)** to hold the connection. The default is 1 minute. 7. Select **Save**. #### Password > [!NOTE] > > **Screenshot** > > [![OAuth 2.0 Password connection settings]()]() 1. Select **OAuth 2.0**. 2. From the **Grant Type** dropdown list, select **Password**. 3. Enter the **OAuth 2.0 Token URL** for generating an access token. 4. Enter the OAuth 2.0 **Username** and the corresponding **Password**. 5. (Optional) Enter the value of **Connection Timeout (In minutes)** to hold the connection. The default is 1 minute. 6. Select **Save**. ### API Token > [!NOTE] > > **Screenshot** > > [![API Token connection settings]()]() 1. Select **API Token**. 2. Enter the **API Token** into the **API Token** field. 3. Select **Save**. ## Aggregation Settings Provide the settings for your aggregation. For more information about aggregation, refer to [Loading Account Data](). > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() 1. Enter the **Page Size** as a number of records to fetch in one request. The default value is 50. 2. Enter the **Account Filter** to aggregate the user resources. For example, `username sw "S"`. 3. Enter the **Group Filter** to aggregate the group resources. For example, `DisplayName sw "S"`. 4. To aggregate any additional fields, during the aggregation operation, in the **JSON Path Attribute Mapping** panel, specify the schema attribute and its corresponding JSON path for the attribute. For any JSON path that is added, the same corresponding schema attribute needs to be added in the Account Schema. For more information on adding an attribute to the Account Schema, refer to [Editing an Account Schema](). To add or remove items, use **Add Another** and the **Recycle Bin** icon. 5. 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 BeyondTrust Password Safe SaaS > [!NOTE] > > **Integration** > > This is an integration and requires additional licensing or subscriptions to utilize it. For more information, contact your customer success manager. The SailPoint and Privileged Account Management source for BeyondTrust Password Safe SaaS provides a standardized approach to managing accounts in SailPoint. This document is designed to give specific information about the requirements and field definitions needed to get a working instance of a BeyondTrust Password Safe SaaS source. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features This page lists the features supported by the BeyondTrust Password Safe SaaS connector. It also lists supported use cases that the connector can assist with. > [!NOTE] > > Before you can use any item marked with an asterisk (\*), SailPoint must activate the feature for your site. For more information on opening a support ticket, refer to [Working With Services](). ### Account Management - Aggregation (local and external users) > **Note** > > Local users are users which reside locally in the PAM system. External users are users synced from a managed system outside of the PAM system. - Aggregate a single account - Create account through provisioning (local users only) - Enable and disable accounts through provisioning - Add and remove entitlement(s) - Delete accounts ### Entitlement Management (groups) - Group aggregation - Aggregate a single group - Aggregate Container permissions as Direct permissions ## Supported Use Cases The following use cases are facilitated by the BeyondTrust Password Safe SaaS connector. ### Read Operation - Fetch local and external users from the PAM system. - Fetch local groups from the PAM system. - View Safes / Containers and view how their permissions are assigned to groups. ### Provisioning - Create local users on the PAM system. - Add or remove internal and external users from local groups. This indirectly assigns and revokes Safes and their associated permissions. - Enable or disable internal and external users residing on the PAM system. For more information on features, refer to [Source Features](). ## Prerequisites - The BeyondTrust Password Safe (Cloud) application as set-up in your IT environment. ## Supported Managed Systems The BeyondTrust Password Safe SaaS connector supports interactions with the managed systems listed on this page. - BeyondInsight version 23.3.0.813 and later ## Required Permissions For the permissions and access details, refer to [BeyondTrust BeyondInsight Guides](). # Machine Account Attributes ## Machine Account Provisioning Attributes Use the following table to map each machine account attribute to its display name, data type, requirement status, and usage notes. | Field (name) | Type | Required | Notes | | --- | --- | --- | --- | | userName | string | Yes | Unique username for the machine account. For example, `machine_username`. | | emails.work.primary.value | string | Yes | Work primary email address for the machine account. For example, `machine_username@machine.local`. | | name.givenName | string | No | The given name of the user. | | active | boolean | No | A Boolean value indicating the machine account's administrative status. | | password | secret | No | Password for the machine account. | For additional details about machine account implementation, refer to the [Machine Identity Security Overview](). # Provisioning The BeyondTrust Password Safe SaaS connector supports provisioning, allowing you to create and manage accounts and entitlements in BeyondTrust Password Safe directly from SailPoint. **Prerequisite:** Your system is configured for provisioning. When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*. When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment. For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account. > [!IMPORTANT] > > This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail. ## Default Create Account Attributes | Account Attribute | Generator | Description | | --- | --- | --- | | email | Identity Attribute | The work email address of user. | | name.givenName | Identity Attribute | The first name of user. | | userName | Identity Attribute | The username for operations. | | active | Static | The active status of user. | | password | Static | The password of user. | # 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 BeyondTrust Password Safe SaaS 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 BeyondTrust Password Safe SaaS source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | UserName | Equals | name | | email | Equals | email | ## 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 | | ID | Group | ### Default Account Attributes The BeyondTrust Password Safe SaaS 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 unique identifier for the user. | | userName | The unique username for the user. | | name.formatted | The full name. | | name.familyName | The family name of the user. | | name.givenName | The given name of the user. | | displayName | The name of the user, suitable for display to end-users. | | Title | The user's title, such as 'Vice President'. | | userType | Used to identify the relationship between the organization and the user. | | active | A Boolean value indicating the user's administrative status. | | manager.value | The manager value. | | organization | The organization. | | email | The email address for the user. | | emails.work.primary.display | A human-readable name, primarily used for display purposes. | | emails.work.secondary.display | A human-readable name, primarily used for display purposes. | | emails.work.primary.value | The email address value. | | emails.work.secondary.value | The email address value. | | emails.home.primary.display | A human-readable name, primarily used for display purposes. | | emails.home.secondary.display | A human-readable name, primarily used for display purposes. | | emails.home.primary.value | Email address value. | | emails.home.secondary.value | The email address value. | | emails.other.primary.display | A human-readable name, primarily used for display purposes. | | emails.other.secondary.display | A human-readable name, primarily used for display purposes. | | emails.other.primary.value | The email address value. | | emails.other.secondary.value | The email address value. | | phoneNumbers.work.primary.display | A human-readable name, primarily used for display purposes. | | phoneNumbers.work.secondary.display | A human-readable name, primarily used for display purposes. | | phoneNumbers.work.primary.value | Phone number of the user. | | phoneNumbers.work.secondary.value | Phone number of the user. | | phoneNumbers.home.primary.display | A human-readable name, primarily used for display purposes. | | phoneNumbers.home.secondary.display | A human-readable name, primarily used for display purposes. | | phoneNumbers.home.primary.value | The phone number of the user. | | phoneNumbers.home.secondary.value | The phone number of the user. | | phoneNumbers.mobile.primary.display | A human-readable name, primarily used for display purposes. | | phoneNumbers.mobile.secondary.display | A human-readable name, primarily used for display purposes. | | phoneNumbers.mobile.primary.value | The phone number of the user. | | phoneNumbers.mobile.secondary.value | Phone number of the user. | | costCenter | The cost center for the user. | | department | The department for the user. | | groups | A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated. | | externalId | An identifier for the resource as defined by the provisioning client. | | LinkedObject.Source | The name of the external application on which the object lives. If this is a PAM local object, this is null. | | LinkedObject.NativeIdentifier | The native identifier of the object on the external application, for example the LDAP DN. If this is a PAM local object, this is null. | ## 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 Attributes The BeyondTrust Password Safe SaaS 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 | | --- | --- | | id | The unique identifier for the group. | | displayName | The displayable name of the group. | | members.value | The members of the group. | | description | The description of the group. | ## Default Machine Identity Attributes Machine Identity attributes define the multiple types of machine identities that can be assigned to the managed system's user accounts. For more information, refer to [Machine Identity Security Overview](). | Attribute Name | Description | | --- | --- | | userName | Unique username for the machine account (for example, `machine_username`). | | emails.work.primary.value | Work primary email address for the machine account (for example, `machine_username@machine.local`). | | name.givenName | The given name of the user. | | active | A Boolean value indicating the machine account's administrative status. | | password | Password for the machine account. | # 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]().