# Connecting SailPoint and Imprivata VPAM

To connect SailPoint with Imprivata VPAM, 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](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>). 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. Select **Virtual Appliance**. A virtual appliance is a Linux-based virtual machine that connects to your sources and apps using SailPoint APIs, connectors, and integrations. For more information about configuring and deploying virtual appliances, refer to [SailPoint Virtual Appliances](<https://documentation.sailpoint.com/saas/help/va/index.html>).
4. (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](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
5. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section.
6. 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](<https://documentation.sailpoint.com/saas/help/sources/index.html#assigning-a-source-owner>).
4. Under **Connection Type**, select **Direct Connection** or **Flat File**.

   - **Direct Connection** - A direct connection fetches data from the **Virtual Appliance Cluster** you choose as the application connector for the source. A direct connection configuration allows for real-time updates. For more information about configuring and deploying virtual appliances, refer to the [Virtual Appliance Reference Guide](<https://documentation.sailpoint.com/saas/help/va/index.html>).
   - **Flat File** - Select the flat file if no connector is available, or if another system restricts the connection. This option allows only reading and aggregating data as a generic/delimited application. Provisioning activity is unsupported, and additional configuration pages like connection settings and aggregation settings are unavailable.
5. If you selected **Direct Connection**, in **Virtual Appliance Cluster**, select the virtual appliance cluster that will be used as the application connector for the source.
6. (Optional) Select a governance group to grant its members [source](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#source-sub-admin-user-level>) or [role](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#role-sub-admin-user-level>) sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html>).
7. 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](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>).
8. 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. In the **Virtual Appliance Cluster** dropdown list, select the virtual appliance to use when communicating with your organization's systems. For more information, refer to [SailPoint Virtual Appliances](<https://documentation.sailpoint.com/saas/help/va/index.html>).
4. (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](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
5. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information.
6. (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](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html#associating-a-governance-group-with-a-source>).
7. (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.
8. Select **Save**.

## Connection Settings

Provide the information required to connect to the Imprivata VPAM managed system:

> [!NOTE]
>
> **Screenshot**
>
> [![alt text](<https://documentation.sailpoint.com/connectors/imprivata_vpam/va/help/img/conn_settings.png>)](<https://documentation.sailpoint.com/connectors/imprivata_vpam/va/help/img/conn_settings.png>)

1. Enter the **Base URL** of the Imprivata VPAM system. For example:

   `https://<domainName>.securelinkcloud.net/rss-servlet`
2. Enter the **Username** for the account that has permission to access the Imprivata managed system. This account should have the necessary privileges to perform the required actions.
3. Enter the **Client ID** generated in the Imprivata VPAM system. For more information, refer to [To generate Client Credentials from the managed Imprivata VPAM system](<https://documentation.sailpoint.com/connectors/imprivata_vpam/va/help/index.html#prerequisites>).
4. Enter the **Client Secret** generated in the Imprivata VPAM system.

   > **Important**
   >
   > Ensure you enter the most recent client secret when configuring Imprivata VPAM operations, as Imprivata supports rotating secrets.
5. Select **Save**.

## Feature Management

Provide the information to manage the features for your configuration of Imprivata VPAM:

> [!NOTE]
>
> **Screenshot**
>
> [![alt text](<https://documentation.sailpoint.com/connectors/imprivata_vpam/va/help/img/feature_manage.png>)](<https://documentation.sailpoint.com/connectors/imprivata_vpam/va/help/img/feature_manage.png>)

1. Select **Manage User** to manage standard users.
2. Select **Manage Vendor Rep** to manage vendor representatives.
3. Select **Save**.

## Aggregation Settings

Configure settings related to account aggregation.

### Filter Settings for Accounts

> [!NOTE]
>
> **Screenshot**
>
> [![alt text](<https://documentation.sailpoint.com/connectors/imprivata_vpam/va/help/img/filter_acc.png>)](<https://documentation.sailpoint.com/connectors/imprivata_vpam/va/help/img/filter_acc.png>)

1. Enter the **User Filters** to define the scope of the users included in account aggregation processes.
2. Enter the **Vendor Rep Filters** to define the scope of the vendor representative accounts included in account aggregation processes.

For more information on configuring account filters, refer to [Filter Examples for Accounts](<#filter-examples-for-accounts>).

### Filter Settings for Entitlements

> [!NOTE]
>
> **Screenshot**
>
> [![alt text](<https://documentation.sailpoint.com/connectors/imprivata_vpam/va/help/img/filter_entitlements.png>)](<https://documentation.sailpoint.com/connectors/imprivata_vpam/va/help/img/filter_entitlements.png>)

1. Enter the **User Group Filters** to define the scope for grouping users based on their attributes during entitlement aggregation.
2. Enter the **Role Filters** to define the scope of the roles aggregated during entitlement aggregation.
3. Enter the **Credentials Category Filters** to define the scope of the credentials category during entitlement aggregation.
4. Enter the **Application Group Filters** to define the scope of the applications within a specific group aggregated during entitlement aggregation.

For more information on configuring entitlement filters, refer to [Filter Examples for Entitlements](<#filter-examples-for-entitlements>).

### Pagination Settings

> [!NOTE]
>
> **Screenshot**
>
> [![alt text](<https://documentation.sailpoint.com/connectors/imprivata_vpam/va/help/img/page_settings.png>)](<https://documentation.sailpoint.com/connectors/imprivata_vpam/va/help/img/page_settings.png>)

1. Enter the **Page Size**, which is the number of records to aggregate in a single page. The default value is 100, and the maximum allowed value is 100.
2. Select **Save**.

## Configuring Filter Settings

Here are examples of filters that can be used with the Imprivata VPAM to retrieve specific data based on different criteria.

> [!NOTE]
>
> To access any of the links in the Imprivata documentation below, the user must exist on the Imprivata VPAM managed system.

### Filter Examples for Accounts

| Type | Filter Example | Description |
| --- | --- | --- |
| User | `filters['name']=[User_Name1]`<br>OR<br>`filters['name']=[User_Name1]&filters['status']=1` | This allows you to retrieve users by their name or by a combination of name and status. For more information, refer to example of [User Filters](<https://sailpoint.securelinkcloud.net/rss-servlet/api-documentation/index_sle.html#_user_2>) in Imprivata documentation. |

### Filter Examples for Entitlements

| Type | Filter Example | Description |
| --- | --- | --- |
| User Group | `filters['name']=[Usergrp_Name1]`<br>OR<br>`filters['name']=[Usergrp_Name1],[Usergrp_Name2]` | This allows you to retrieve user groups by their name. You can specify a single user group name or multiple user group names separated by commas. For more information, refer to example of [User Group Filters](<https://sailpoint.securelinkcloud.net/rss-servlet/api-documentation/index_sle.html#_user_group>) in the Imprivata documentation. |
| Role | `filters['name']=[Role_Filter1]`<br>OR<br>`filters['name']=[Role_Filter1],[Role_Filter2]` | This allows you to retrieve roles by their name. You can specify a single role name or multiple role names separated by commas. For more information, refer to example of [Role Filters](<https://sailpoint.securelinkcloud.net/rss-servlet/api-documentation/index_sle.html#_role>) in the Imprivata documentation. |
| Application Group | `filters['name']=[ApplicationGroup_Filter1]`<br>OR<br>`filters['name']=[ApplicationGroup_Filter1],[ApplicationGroup_Filter2]` | This allows you to retrieve application groups by their name. You can specify a single application group name or multiple application group names separated by commas. For more information, refer to example of [Application Group Filters](<https://sailpoint.securelinkcloud.net/rss-servlet/api-documentation/index_sle.html#_application_group>) in the Imprivata documentation. |
| Credentials Category | `filters['name']=[CredCategory_Filter1]`<br>OR<br>`filters['name']=[CredCategory_Filter1],[CredCategory_Filter2]` | This allows you to retrieve credentials categories by their name. You can specify a single credentials category name or multiple credentials category names separated by commas. For more information, refer to example of [Credential Category Filters](<https://sailpoint.securelinkcloud.net/rss-servlet/api-documentation/index_sle.html#_credential_category>) in the Imprivata documentation. |

## 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**.

> [!IMPORTANT]
>
> Run the Test Connection only once during the initial setup to verify connectivity with the source. If the test completes successfully but the source becomes unhealthy later, do not run Test Connection again. Instead, try other operations, as Test Connection cannot handle rotating client secrets.

## SailPoint Application Onboarding

> [!IMPORTANT]
>
> SailPoint application onboarding is only available to business and business plus customers. For more information, contact your SailPoint CSM.

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](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.
