# SailPoint CyberArk Privilege Cloud Shared Services Connector Documentation

> CyberArk Privilege Cloud Shared Services Connector Documentation

# Documentation

# Connecting SailPoint and CyberArk Privilege Cloud Shared Services

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. 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 and interact with the source.

> [!NOTE]
>
> **Screenshot**
>
> [![Connection Settings](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/va/help/img/connection_settings.png>)](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/va/help/img/connection_settings.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 with. For example, you can use the following:

   `https://{your CyberArk Privilege Cloud Shared Services Domain}/scim/v2`
3. 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/va/help/img/oauth2_connection_settings.png>)](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/va/help/img/oauth2_connection_settings.png>)

1. In the **Connection** settings, 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** 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_privilege_cloud_shared_services/va/help/img/api_token_connection_settings.png>)](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/va/help/img/api_token_connection_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_privilege_cloud_shared_services/va/help/img/aggregation_settings.png>)](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/va/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

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_privilege_cloud_shared_services/va/help/img/additional_settings.png>)](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/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.

# Integrating SailPoint with CyberArk Privilege Cloud Shared Services

> [!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 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 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 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 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 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 connector supports the following managed system:

- CyberArk Privilege Cloud Shared Services

## Prerequisites

- Configure at least one virtual appliance cluster and successfully test the connection. For instructions, refer to the [Virtual Appliance Reference Guide](<https://documentation.sailpoint.com/saas/help/va/index.html>).
- 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 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 connector uses the following default correlation and object configurations.

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

# Migrate VA-based Source to a SaaS Source

Some sources that are connected to virtual appliance (VA) clusters can be migrated to SaaS connections. This ensures data (users and entitlements) remain intact and can maintains your source configurations like access profiles, roles, password settings, and correlation configurations when switching from a VA cluster to a SaaS connection.

To migrate a source from a VA-based source to a SaaS source, you will provide configuration details on a draft version of the source before publishing the source.

> [!NOTE]
>
> - You must have an Admin or Source Admin user level to migrate a source.

A draft version of the source is created. As your migration process is in progress the live source will continue to work as it is.

For more information on the CyberArk Privilege Cloud Shared Services SaaS connector, refer to the [CyberArk Privilege Cloud Shared Services SaaS Supported Features](<https://documentation.sailpoint.com/cyberark_privilege_cloud_shared_services/saas/help/index.html#supported-features>).

## Important Considerations Before Migrating

- You do not need to edit additional configurations (other than connection credentials) to migrate the source.
- If your source migration is in progress, please do not make any configuration changes to your live source as those can be overwritten once you apply the migration your draft version.
- Once you've gone ahead with your migration, it can't be rolled back. Your source is permanently migrated to a SaaS source.
- Any preview operations or configuration changes on the draft source will not impact the live source until you apply the migration.

## Migrating Sources

To migrate your source, complete the following:

1. Go to **Admin \> Connections \> Sources**.
2. Select or edit the VA-based source you want to migrate.
3. Open the source configuration, and select **Migrate to SaaS**.
4. When prompted, select **Continue**.

   A draft version of the source is created. The live source will continue to work.
5. Select **Connection Settings**.
6. Re-enter encrypted configuration details. For example, you might need to re-enter the Client Secret, Password, Refresh Token, Personal Access Token (PAT), or Certificates to migrate from the VA cluster to the SaaS connection.

   > **Important**
   >
   > Avoid editing the other configuration options in the draft source.
7. Select **Review and Test**.
8. Select **Test Connection**.
9. (Optional) Select **Accounts**. If you successfully tested your connection in **Review and Test**, you can select **Preview** to display a subset of accounts from the application that will be mapped to SailPoint identities. This can help ensure you are accurately connecting identity data from the application with SailPoint identities.
10. (Optional) Select **Entitlements**. If you successfully tested your connection in **Review and Test** and your source type supports entitlement type configuration, you can select **Preview** to view a preview of entitlements using the current configuration settings.
11. When you've finished reviewing your changes and successfully tested your connection, select **Apply Migration**.

    Your changes will be applied to the live source and the draft source will be deleted.

## Viewing Source Migration Status

You can view the status and creation date of draft sources.

1. Go to **Admin \> Connections \> Sources \> Source Migration Status**.
2. Select **Source Migration Status**.
3. To view or edit the draft source, select **Actions** ![](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/va/help/common/assets/img/actions_menu.png>) **\> Preview** on the draft source.
4. To delete the draft source, select **Actions** ![](<https://documentation.sailpoint.com/connectors/cyberark_privilege_cloud_shared_services/va/help/common/assets/img/actions_menu.png>) **\> Delete** on the draft source.

# Enable Connector Logging

This topic provides the steps needed to enable logging on SailPoint using REST APIs.

> [!NOTE]
>
> This topic only applies to VA-based integrations.

> [!NOTE]
>
> The examples provided might not match your configuration. Use the logging levels and logging classes reference at the bottom of the topic to configure your API responses to match your connector.

This process is broken up into four steps:

1. Identify the Virtual Appliance (VA) cluster on which you want to enable logging.
2. Get the logging configuration for the existing VA cluster.
3. Update the VA cluster to enable logging levels.
4. Observe logging changes to the logging levels.

### Identify the Virtual Appliance Cluster

Select the VA on which you need to enable logging using REST API. If you already know the VA application's `id`, proceed to [Get the Logging Configuration](<#get-the-logging-configuration>).

1. Make the following call to the REST API to return a list of available VA clusters:

   GET /v3/managed-clusters

   The REST API returns a response that looks similar to the following:

   ```json
   [
       {
           "id": "2c9180866166b5b0016167c32ef31a66",
           "name": "Development Cluster",
           "description": "Development Cluster",
           "clientType": "CCG",
           "ccgVersion": "373_535_70.2.0",
           "pinnedConfig": true,
           "logConfiguration": null
       },
       {
           "id": "2c9180846a93ce60016ab29f039944de",
           "name": "Cloud Cluster",
           "description": "Cloud Cluster",
           "clientType": "CCG",
           "ccgVersion": "373_535_70.2.0",
           "pinnedConfig": true,
           "logConfiguration": {
               "clientId": null,
               "durationMinutes": 60,
               "expiration": "2020-12-15T19:13:36.079Z",
               "rootLevel": "DEBUG",
               "logLevels": {
                   "sailpoint.connector.ADLDAPConnector": "DEBUG"
               }
           }
       }
   ]
   ```

   > **Note**
   >
   > The previous example code shows two VA clusters. One VA cluster has a log configuration and the other does not (refer to the `logConfiguration` value in each returned VA cluster). This is because one of the clusters already has logging enabled. This is just an example configuration, and your environment may not have logging enabled on a cluster.
2. Identify the VA cluster that you want to enable logging on by its name or description and record its `id` attribute.

### Get the Logging Configuration

Get your selected VA's cluster logging configuration and identify the values you need to update.

1. Make the following call to the REST API to return the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier.

   GET /v3/managed-clusters/{id}/log-config

   - If the VA doesn't have a logging configuration currently set, it returns `204 No Content` as a response.
   - If the VA has an existing logging configuration, it returns something similar to the following:

     ```json
     {
         "clientId": null,
         "durationMinutes": 60,
         "expiration": "2020-12-15T19:13:36.079Z",
         "rootLevel": "DEBUG",
         "logLevels": {
             "sailpoint.connector.ADLDAPConnector": "DEBUG"
         }
     }
     ```

     You'll need to configure the following information in the response:

     - `durationMinutes` is the number of minutes logging should remain enabled.
     - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>).
     - `logLevels` is a map object with logging classes as keys and logging levels as values.

       - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes.
       - For a list of available values, refer to [Logging Levels](<#logging-levels>).

### Update Logging Configuration

Update the VA cluster configuration returned by the REST API to update the logging settings as needed.

1. Make the following call to the REST API to update the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier.

   PUT /v3/managed-clusters/{id}/log-config
2. Submit your configuration changes to the REST API in a JSON body.

   - If the VA cluster did not already have a logging configuration and you received a `204 No Content` response, you can create a new one.
   - If the VA returned a configuration, you can edit it to include the changes.

   The JSON body should be as follows:

   ```json
   {
       "durationMinutes": 60,
       "rootLevel": "DEBUG",
       "logLevels": {
           "sailpoint.connector.ADLDAPConnector": "DEBUG"
       }
   }
   ```

   Consider the following as you edit the JSON:

   - `durationMinutes` is the number of minutes logging should remain enabled.
   - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>).
   - `logLevels` is a map object with logging classes as keys and logging levels as values.

     - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes.
     - For a list of available values, refer to [Logging Levels](<#logging-levels>).

   If the update was successful, the REST API should return a response similar to the following:

   ```json
   {
       "clientId": null,
       "durationMinutes": 60,
       "expiration": "2020-12-15T19:13:36.079Z",
       "rootLevel": "DEBUG",
       "logLevels": {
           "sailpoint.connector.ADLDAPConnector": "DEBUG"
       }
   }
   ```

### Observe Logging Changes

Approximately five minutes after you update the configuration, the VA cluster starts generating log files you can review. You can view the log files in **ccg.log**.

### References

The tables in this reference section list information that can be helpful when creating the JSON body you'll use to configure the VA cluster's configuration file.

#### Logging Levels

| Logging Level | Description |
| --- | --- |
| ERROR | Designates error events that might still allow the connector to continue. |
| WARN | Designates potentially harmful situations. |
| INFO | Designates information messages that highlight process at a coarse-grain level. |
| DEBUG | Very verbose. Fine grain logging levels used for development and debugging. |
| TRACE | Most verbose. Finer grain logging levels than debugging. |

#### Logging Classes

| Connector | Logging Class |
| --- | --- |
| Active Directory | sailpoint.connector.ADLDAPConnector sailpoint.connector.LDAPConnector |
| AIX | openconnector.connector.unix.AIXConnector openconnector.connector.unix.UnixConnector |
| Amazon Web Services | logger.aws.name=openconnector.connector.aws logger.aws.level=trace logger.aws.additivity = false logger.aws.appenderRef.rolling.ref = STDOUT |
| Atlassian Suite Cloud | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianConnector |
| Atlassian Data Center | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianDataCenterConnector |
| Microsoft Entra ID | sailpoint.connector.AzureADConnector |
| Box | openconnector.connector.BoxNetConnector sailpoint.connector.OpenConnectorAdapter |
| Cerner | openconnector.connector.CernerConnector sailpoint.connector.OpenConnectorAdapter |
| Delimited File | logger.DelimitedFileConnector.name = sailpoint.connector.DelimitedFileConnector logger.DelimitedFileConnector.level = debug logger.DelimitedFileConnector.additivity = false logger.DelimitedFileConnector.appenderRef.rolling.ref = STDOUT |
| Dropbox | openconnector.connector.DropBoxConnector sailpoint.connector.OpenConnectorAdapter |
| Epic | openconnector.connector.EPICConnector sailpoint.connector.OpenConnectorAdapter |
| GE Centricity | openconnector.connector.GECentricity sailpoint.connector.OpenConnectorAdapter |
| Google Apps / G Suite | openconnector.connector.GoogleAppsDirect sailpoint.connector.OpenConnectorAdapter |
| IBM i | openconnector.connector.IBMiConnector |
| Lotus Domino | sailpoint.connector.LotusDomino |
| JDBC | sailpoint.connector.JDBCConnector |
| Sun One LDAP | sailpoint.connector.LDAPConnector |
| Linux | openconnector.connector.unix.LinuxConnector sailpoint.connector.OpenConnectorAdapter sailpoint.connector.UnixConnector |
| Microsoft Office365 | sailpoint.connector.Office365Connector |
| Microsoft SQL Server | sailpoint.connector.mssql.serviceimpl.MSSQLServerConnectorV2 |
| Okta | logger.openconnector.name = openconnector.connector.okta.OktaConnector logger.openconnector.level = debug logger.openconnector.additivity = false logger.openconnector.appenderRef.rolling.ref = STDOUT |
| Oracle Database | sailpoint.connector.OracleDBConnector sailpoint.connector.JDBCConnector |
| Oracle E-Business | sailpoint.connector.OracleEBSConnector sailpoint.connector.JDBCConnector |
| Oracle Fusion HCM | openconnector.connector.oraclefusionhcm.OracleFusionHCMConnector sailpoint.connector.OpenConnectorAdapter |
| Oracle HCM Cloud | sailpoint.connector.oraclehcmcloud.OracleHCMCloudConnector |
| Oracle HRMS | sailpoint.connector.OracleAppsHRMSConnector sailpoint.connector.JDBCConnector |
| Oracle Netsuite | openconnector.connector.netsuite.NetsuiteConnector |
| PeopleSoft ERP | openconnector.connector.PeopleSoftConnector sailpoint.connector.OpenConnectorAdapter |
| PeopleSoft HRMS | sailpoint.connector.PeopleSoftHRMSConnector |
| RemedyForce | sailpoint.connector.ForceConnector |
| RSA Authentication Manager | openconnector.connector.RSAConnector openconnector.connector.rsa.RSAHTTPClient sailpoint.connector.OpenConnectorAdapter |
| Salesforce | sailpoint.connector.ForceConnector |
| SAP Concur | openconnector.connector.sapconcur.SAPConcurConnector |
| SAP - Direct | sailpoint.connector.SAPConnector sailpoint.connector.SAPInternalConnector |
| SAP GRC | logger.SAPGRCConnector.name = sailpoint.connector.sapgrc logger.SAPGRCConnector.level = debug logger.SAPGRCConnector.additivity = false logger.SAPGRCConnector.appenderRef.rolling.ref = STDOUT |
| SAP HR/HCM | sailpoint.connector.SAPHRInternalConnector |
| SCIM 1.1 | openconnector.connector.SCIMConnector sailpoint.connector.OpenConnectorAdapter |
| SCIM 2.0 | openconnector.connector.scim2.SCIM2Connector sailpoint.connector.OpenConnectorAdapter |
| ServiceNow | openconnector.connector.servicenow.ServiceNowConnector openconnector.connector.servicenow.ServiceNowRestClient sailpoint.connector.OpenConnectorAdapter |
| ServiceNow Service Desk Integration | openconnector.connector.servicedesk.ServiceNowServiceDeskConnector sailpoint.connector.OpenConnectorAdapter |
| Siebel | openconnector.connector.SiebelConnector sailpoint.connector.OpenConnectorAdapter |
| Snowflake | openconnector.connector.snowflake.SnowflakeConnector sailpoint.connector.OpenConnectorAdapter |
| Solaris | openconnector.connector.unix.SolarisConnector openconnector.connector.unix.UnixConnector sailpoint.connector.OpenConnectorAdapter |
| SuccessFactors | sailpoint.connector.SuccessFactorsConnector |
| Sybase | sailpoint.connector.SybaseDirectConnector sailpoint.connector.JDBCConnector |
| Webex | openconnector.connector.Webex sailpoint.connector.OpenConnectorAdapter |
| Workday | openconnector.connector.WorkDay sailpoint.connector.OpenConnectorAdapter |
| Workday Accounts | openconnector.connector.workdayaccounts openconnector.connector.workdayaccounts.WorkdayAccountsConnector sailpoint.connector.OpenConnectorAdapter |
| Web Services | sailpoint.connector.WebServices |
| XML | openconnector.connector.XMLConnector sailpoint.connector.OpenConnectorAdapter |
| Yammer | openconnector.connector.YammerConnector sailpoint.connector.OpenConnectorAdapter |
| Zoom | openconnector.connector.zoom.ZoomConnector sailpoint.connector.OpenConnectorAdapter |

# 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/>)

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

## Updating Custom Extended Attributes operation fails with error - com.jayway.jsonpath.PathNotFoundException

**Resolution:** Add the following parameter to the application with a boolean value of true, and then verify if the issue persists:

```text
"includeExtendedSchemaUrnInSchemasList": true
```