# Connecting SailPoint and CyberArk PAM (Self-Hosted)

To connect SailPoint with CyberArk PAM, 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](<https://documentation.sailpoint.com/saas/help/sources/index.html#assigning-a-source-owner>).
8. 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.
9. 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.
10. (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>).
11. 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>).
12. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there.

## Connection Settings

Provide the information required to connect to and interact with the source.

> [!NOTE]
>
> **Screenshot**
>
> [![Connection Settings](<https://documentation.sailpoint.com/connectors/cyberark_pam_selfhosted/va/help/img/connection_.png>)](<https://documentation.sailpoint.com/connectors/cyberark_pam_selfhosted/va/help/img/connection_.png>)

To configure connection settings, complete the following:

1. Enter the value of **Connection Timeout** in minutes to hold the connection. By default, it is one minute.
2. Enter the **Host URL** of the managed system that you are connecting to. For example, you can use the following:

   `https://{your CyberArk Domain}/scim/v2`
3. Select and configure your authentication type:

   - [OAuth 2.0 Authentication Type](<#oauth-20-authentication-type>)
   - [API Token](<#api-token>)

### OAuth 2.0 Authentication Type

You can use OAuth 2.0 authentication which uses an access token to authenticate the connection. Access tokens are generated based on the selected grant type. Currently, only **Client Credentials** is supported. A generated token can be used.

> [!NOTE]
>
> **Screenshot**
>
> [![OAuth 2.0 Authentication Type](<https://documentation.sailpoint.com/connectors/cyberark_pam_selfhosted/va/help/img/oauth_con.png>)](<https://documentation.sailpoint.com/connectors/cyberark_pam_selfhosted/va/help/img/oauth_con.png>)

1. In the **Connection** settings, set the **Authentication Type** to **OAuth 2.0**.
2. Select **Client Credentials** from the **Grant Type** dropdown list.
3. Enter the **OAuth 2.0 Token URL** for generating an access token.
4. Enter the **Client ID** for OAuth 2.0 authentication.
5. Enter the **Client Secret** for OAuth 2.0 authentication.
6. Select **Save**.

### API Token

Configure API Token authentication.

> [!NOTE]
>
> **Screenshot**
>
> [![API Token](<https://documentation.sailpoint.com/connectors/cyberark_pam_selfhosted/va/help/img/apitoken_authentication_settings.png>)](<https://documentation.sailpoint.com/connectors/cyberark_pam_selfhosted/va/help/img/apitoken_authentication_settings.png>)

1. In the **Connection** settings, set the **Authentication Type** to **API Token**.
2. Enter the API token into the **API Token** field.
3. Select **Save**.

## Aggregation Settings

Configure the settings the connector uses to aggregate identity data.

For more information about aggregation, refer to [Loading Account Data](<https://documentation.sailpoint.com/saas/help/accounts/loading_data.html>).

> [!NOTE]
>
> **Screenshot**
>
> [![Aggregation Settings](<https://documentation.sailpoint.com/connectors/cyberark_pam_selfhosted/va/help/img/agg_final_1.png>)](<https://documentation.sailpoint.com/connectors/cyberark_pam_selfhosted/va/help/img/agg_final_1.png>)
>
> [![Aggregation Settings](<https://documentation.sailpoint.com/connectors/cyberark_pam_selfhosted/va/help/img/agg_final.png>)](<https://documentation.sailpoint.com/connectors/cyberark_pam_selfhosted/va/help/img/agg_final.png>)

To configure connection settings, complete the following:

1. Enter a **Page Size** as a number of records that you can get in one request. The default page size is 50.
2. Enter the **Account Filter** to aggregate the user resources. For example, you can use the following:

   `userName sw "S"`
3. To aggregate any additional fields during the aggregation operation, specify the schema attribute and its corresponding JSON path for the attribute in the **JSON Path Attribute Mapping** panel.

   For any JSON path you add, you need to add a corresponding schema attribute to the Account Schema.
4. Select **Save**.

## Additional Settings

Configure the Retry Error List. This feature lists possible errors the connector may receive from the source during an aggregation which prompts the connector to reattempt the aggregation process.

> [!NOTE]
>
> **Screenshot**
>
> [![Additional Settings](<https://documentation.sailpoint.com/connectors/cyberark_pam_selfhosted/va/help/img/additional_settings.png>)](<https://documentation.sailpoint.com/connectors/cyberark_pam_selfhosted/va/help/img/additional_settings.png>)

1. Provide a list of aggregation errors which should initiate another aggregation attempt into the **Retry Error List** field.

   > **Note**
   >
   > If the source encounters any of these errors during the subsequent attempt, the aggregation process fails.
2. 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](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.