# SailPoint CyberArk Privilege Cloud Shared Services SaaS Connector Documentation

> CyberArk Privilege Cloud Shared Services SaaS Connector Documentation

# Documentation

# Connecting SailPoint and CyberArk Privilege Cloud Shared Services SaaS

To connect SailPoint with CyberArk Privilege Cloud Shared Services, 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. (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>).
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](<https://documentation.sailpoint.com/saas/help/sources/index.html#assigning-a-source-owner>).
4. (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>).
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](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>).
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](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
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](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html#associating-a-governance-group-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

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

> [!NOTE]
>
> **Screenshot**
>
> [![Connection Settings](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/saas/help/img/connection_settings.png>)](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/saas/help/img/connection_settings.png>)

To configure connection settings, complete the following:

1. Enter the **Host URL** of the managed system that you are connecting with. For example, you can use the following:

   `https://{your CyberArk Privilege Cloud Shared Services Domain}/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 which uses an access token to authenticate a 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_privilege_cloud_shared_services/saas/help/img/oauth2_connection_settings.png>)](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/saas/help/img/oauth2_connection_settings.png>)

1. Set the **Authentication Type** to **OAuth 2.0**.
2. Select **Client Credentials** from the **Grant Type** drop-down list.
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 value of **Connection Timeout (In minutes)** to hold the connection. By default, it is one minute.
6. Select **Save**.

### API Token

Configure API Token authentication.

> [!NOTE]
>
> **Screenshot**
>
> [![API Token](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/saas/help/img/api_token_connection_settings.png>)](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/saas/help/img/api_token_connection_settings.png>)

1. Set the **Authentication Type** to **API Token**.
2. Enter the API token into the **API Token** field.
3. Enter the value of **Connection Timeout (In minutes)** to hold the connection. By default, it is one minute.
4. 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_privilege_cloud_shared_services/saas/help/img/aggregation_settings.png>)](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/saas/help/img/aggregation_settings.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 must add a corresponding schema attribute to the Account Schema.
4. Select **Save**.

## Additional Settings

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

1. To send additional parameters, add the **Key** and **Value** for **OAuth2.0 Request Parameters**.
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.

# Integrating SailPoint with CyberArk Privilege Cloud Shared Services SaaS

> [!NOTE]
>
> **Integration**
>
> This is an integration and requires additional licensing or subscriptions to utilize it. For more information, contact your customer success manager.

SailPoint and the Privileged Account Management source for CyberArk Privilege Cloud Shared Services SaaS provides a capability of deep governance for Accounts and Groups (Safes). This integration is capable of end-to-end life cycle management.

This guide is designed to give specific information about the requirements and field definitions needed to get a working connection to CyberArk Privilege Cloud Shared Services SaaS in SailPoint.

> [!NOTE]
>
> To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes](<https://community.sailpoint.com/release-notes/saas>) page.

## Supported Features

The SailPoint CyberArk Privilege Cloud Shared Services SaaS connector supports the following features:

> [!NOTE]
>
> Before you can use any item marked with an asterisk (\*), SailPoint must activate the feature for your site.

#### Account Management

- Aggregation (Internal and External Users)
- Refresh account
- Create account provisioning (Local Users)
- Enable/disable account provisioning
- Delete accounts
- Add/remove entitlement(s)

  > **Note**
  >
  > The SailPoint CyberArk Privilege Cloud Shared Services SaaS connector uses PUT method to add Users to Groups via the Groups endpoint.

#### Entitlement Management (Groups)

- Aggregation group(s)
- Single group aggregation
- Aggregate container / safes permissions as direct permissions

For more information on features, refer to [Source Features](<https://community.sailpoint.com/knowledge/Identity-Security-Cloud-Source-Features>).

## Supported Use Cases

The following use cases are facilitated by the CyberArk Privilege Cloud Shared Services SaaS connector:

**Read Operation**

- Fetch local and external users from the PAM system.

  Local users refers to users locally residing in PAM. External users refers to users synced from external managed system to PAM systems.
- Fetch local groups from the PAM system.
- View Safes/Containers and its permissions 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 its associated permissions.
- Enable or disable internal and external users residing on the PAM system.

## Supported Managed Systems

The CyberArk Privilege Cloud Shared Services SaaS connector supports the following managed system:

- CyberArk Privilege Cloud Shared Services

## Prerequisites

- You must have the CyberArk Identity SCIM Server enabled on your enterprise instance. For more information, refer to [CyberArk Identity's SCIM Server](<https://docs.cyberark.com/Product-Doc/OnlineHelp/Idaptive/Latest/en/Content/Integrations/CyberArk-SCIM-PCloud.htm?tocpath=Administrator%7CIntegrations%7C_____2>) or reach out to your CyberArk partner.

> [!NOTE]
>
> Upgrade from CyberArk Privilege Cloud to CyberArk Privilege Cloud Shared Services is not supported.
>
> Email ID (`emails.work.primary.value`) is mandatory for correlating the accounts in SailPoint.

## Required Permissions

For the permissions and access details, refer to [SCIM Server Configuration](<https://identity-developer.cyberark.com/docs/scim-server-configuration>).

# Provisioning

The CyberArk Privilege Cloud Shared Services SaaS connector supports provisioning, allowing you to create and manage accounts and entitlements in CyberArk Privilege Cloud Shared Services 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 |
| --- | --- | --- |
| userName | Generator (Create Unique Account ID). This generator uses the value in the Pattern Used field to generate a unique User ID for the new account. | The username of the user |
| email.work.primary.value | Identity Attribute | Email address for the user |
| active | Static | Determines whether user is active on the managed system |
| 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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.
> - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified.

The CyberArk Privilege Cloud Shared Services 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](<https://documentation.sailpoint.com/saas/help/accounts/correlation.html>) for more information.

When you first create the CyberArk Privilege Cloud Shared Services SaaS source, the default correlation mapping is:

| Account Attribute | Operation | Identity Attribute |
| --- | --- | --- |
| emails.work.primary.value | 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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) 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 CyberArk Privilege Cloud Shared Services SaaS connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.

The following is the limited list of account attributes supported by SailPoint CyberArk Privilege Cloud Shared Services SaaS. This list can't be extended.

| Attribute Name | Description |
| --- | --- |
| id | The unique ID of the user. This is an Account ID which must not be changed. |
| userName | The username of the user. Avoid using userName with special characters like `&`, `%`, `+`, `#`, `?`, `<`, `>`, `*`, `"`, `/` or `\`, as they are not supported by CyberArk Privilege Cloud Shared Services SaaS. |
| name.formatted | The formatted name of the User. |
| name.familyName | The family name |
| name.givenName | The last name of the user |
| displayName | The display name of the user |
| emails.work.primary.value | Email address for the user |
| phoneNumbers.work.value | Phone number of the user |
| phoneNumbers.mobile.value | Phone number of the user |
| phoneNumbers.home.value | Phone number of the user |
| manager.value | The unique ID of the Manager |
| manager.displayName | The display name of the Manager |
| meta.location | URL to access SCIM resource |
| members.value | Members of the group |
| active | Determines whether user is active on the managed system |
| organization | The organization of the user |
| meta.resourceType | The SCIM resource type |
| meta.created | Resource creation date and time |
| meta.lastModified | Last modified date and time |
| meta.locaton | The URL to access the SCIM resource |
| LinkedObject.source | Name of the external application on which the object lives. If this is a PAM local object, use `null` as the value. |
| LinkedObject.nativeIdentifier | The native identifier of the object on the external application (for example, LDAP DN). If this is a PAM local object, use `null` as the value. |
| groups | The list of groups the user belongs to. |

## 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](<https://documentation.sailpoint.com/saas/help/access/entitlements.html>) 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 CyberArk Privilege Cloud Shared Services SaaS connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.

The following is the limited list of group attributes supported by the SailPoint CyberArk Privilege Cloud Shared Services SaaS connector. This list can't be extended.

| Attribute Name | Description |
| --- | --- |
| id | The unique ID for the group. This is an Account ID which must not be changed. |
| displayName | The display name for the group |
| members | A list containing each group member's `id` and `displayName` values. If you have an existing source, you must manually add this attribute to the group schema and set `multivalued` to `true` using the REST API. You can also select the **Multi-Valued** checkbox in the attribute configuration interface in SailPoint. |
| members.value | Members of the group |

# 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](<https://documentation.sailpoint.com/saas/help/index.html>)
- [SailPoint Support Knowledge Base](<https://support.sailpoint.com/csm?id=kb_view2&amp;kb_id=05ff44289f011200550bf7b6077fcfa3>)
- [SailPoint Developer Community](<https://developer.sailpoint.com/>)

## Debug Logs

For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings](<https://documentation.sailpoint.com/saas/help/sources/managing_additional_settings.html>).

## Known Issues

These are known issues and will be fixed in an upcoming CyberArk Release

- CyberArk Groups API for User association doesn't work properly when Org is assigned to Groups.
- CyberArk Groups API for User association doesn't work when Groups are hierarchical (Parent-Child) relationship.

## Direct Permissions not visible after Entitlement Aggregation

Direct permissions are not aggregated and do not appear in the Permissions tab of entitlements after entitlement aggregation.

**Resolution:** To resolve this, the customer needs to run an unoptimized entitlement aggregation. For example:

```text
curl --location 'https://tenantname.api.cloud.sailpoint.com/beta/sources/source_id/load-entitlements?disableOptimization=true' \ --header 'Authorization: Bearer <Token>' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'disableOptimization=true'
```

> [!NOTE]
>
> If the issue persists, set `useGroupAggregationWithoutFilter` to **true** in `source.xml` and run an unoptimized entitlement aggregation.