# SailPoint CyberArk Central Credential Provider (CCP) Documentation

> CyberArk Central Credential Provider (CCP) Documentation

# Documentation

# Adding a New Credential Provider in SailPoint

Create a new credential provider integration in SailPoint to automatically rotate refreshed authentication credentials for configured sources.

To create a new credential provider:

1. Go to **Admin \> Connections \> Credential Providers**.
2. Select **Create New**.

   > **Screenshot**
   >
   > [![Credential Providers landing page with the Create New button highlighted](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/common/assets/img/landing_screen.png>)](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/common/assets/img/landing_screen.png>)
3. Search for the credential provider type and select **Configure**.

   > **Note**
   >
   > For a list of the available types of credential providers, as well as access to the documentation for each type, refer to the [Identity Security Connectors](<https://documentation.sailpoint.com/connectors/help/identity_security_connectors.html>) landing page.
4. Enter the following in the provided fields:

   - Enter a unique **Credential Provider Name** to help administrators differentiate it from others.
   - Enter a **Credential Provider Description**.
   - Select a **Credential Provider Owner** who is responsible for the credential provider's operations.
   - Select a **Virtual Appliance Cluster** with connectivity to the credential provider.
5. Select **Continue** to create the new credential provider with your selections.
6. (Optional) Enable credential caching. For more information, refer to [Caching Credentials](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/cred_caching.html>).

# Configure a Source to Use a Credential Provider

After you create a credential provider, you can begin configuring your sources to use it for authentication. When you use a credential provider in a source configuration, any authentication fields you need to configure allow you to use the credential provider or use static authentication credentials.

To configure your source to use a credential provider:

1. In the source's **Base Configuration** tab, select **Use a Credential Provider**.

   > **Note**
   >
   > Enabling a credential provider in your connector adds an additional 30-second timeout for each connector operation.
2. Toggle every secret field in the configuration pages which should use the credential provider to **Credential Path**. The field changes to accept the secret path expression for the credential provider instead of the static value.

   > **Screenshot**
   >
   > **Static Value**
   >
   > [![Static Value field selected](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/img/conn_field_static_2.png>)](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/img/conn_field_static_2.png>)
   >
   > **Credential Path**
   >
   > [![Credential Path field selected](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/img/conn_field_cred_path_2.png>)](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/img/conn_field_cred_path_2.png>)
3. Enter the secret path expression for the credential provider into the **Credential Path** field.

> [!NOTE]
>
> For a list of all available SailPoint credential provider path expressions, refer to [Credential Provider Secret Path Expressions](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/secret_path_expressions.html>).

# Configuring CyberArk Central Credential Provider (CCP)

## Base Configuration

Provide the base configuration parameters. Information you entered during the initial creation of the credential provider is automatically entered into the fields in the **Base Configuration** page. You can edit this information if necessary.

> [!NOTE]
>
> **Screenshot**
>
> [![Base Configuration](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/img/base_config.png>)](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/img/base_config.png>)

> [!NOTE]
>
> Ensure that the name and description of each credential provider is unique.

1. Go to **Admin \> Connections \> Credential Providers**.
2. Search for the credential provider you want to edit.
3. Enter a unique **Credential Provider Name**.
4. Enter a **Credential Provider Description** that provides details necessary to distinguish it from similar credential providers.
5. Select a **Credential Provider Owner** by typing the owner's name into the field provided. Matches display after you type at least two letters. Select the credential provider owner as required.
6. Select a **Virtual Appliance Cluster** with connectivity to the credential provider. 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>).
7. Upload the PFX files required for Certificate Serial Number Authentication. Drag and drop the file onto the **Upload Files** box to upload it, or select anywhere within the **Upload Files** box to choose the file on your computer.
8. Select **Save**.

## Connection Settings

Configure the authentication parameters to connect to and authenticate with the CyberArk Central Credential Provider (CCP).

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

To configure an authenticated connection:

1. Enter the **Host URL** for the CyberArk Central Credential Provider (CCP). For example:

   ```text
   https://{hostname of CyberArk Central Credential Provider (CCP)}/{WebService Name}/
   ```
2. Enter the **Certificate File Name** and **Certificate Password** to authenticate with the CyberArk Central Credential Provider (CCP).
3. (Optional) Enable credential caching. For more information, refer to [Caching Credentials](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/cred_caching.html>).
4. Select **Save**.

# Caching Credentials

SailPoint credential providers can save the credentials it receives from the systems they manage to cache. Cached credentials may expire after a period of time and need to be refreshed. Credential providers can't use expired credentials saved to cache.

> [!NOTE]
>
> **Screenshot**
>
> [![Enable Credentials Caching checkbox](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/img/cred_caching.png>)](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/img/cred_caching.png>)

To enable credential caching for credential providers:

1. Sign in to SailPoint.
2. Go to **Admin \> Connections \> Credential Providers**.
3. Search for the credential provider that you want to enable caching on and select its name.
4. Select **Edit Configuration**.
5. Select the **Enable Credentials Caching** checkbox.

   > **Note**
   >
   > The option to enable this feature may be in a different configuration tab depending on your selected credential provider.
6. Select **Save**.

## Credentials Expiration

Depending on the managed system the credential provider is connected to, the credentials may have an expiration time limit. The credential provider uses the following hierarchy to determine expiration, with the highest priority first and the lowest priority last:

1. If the credentials received from the managed system contain an expiration time, then they are cached until that expiration time.
2. If the credentials received from the managed system don't contain an expiration time, then you can add one by configuring the `expirationTimeInSeconds` attribute in the source of credential provider using APIs.

   > **Note**
   >
   > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.
3. If the credentials received from the managed system don't contain an expiration time and you don't create one via APIs, then by default the credentials expire after one day.

# CyberArk Central Credential Provider (CCP)

The SailPoint CyberArk Central Credential Provider (CCP) provides credential cycling functionality to fetch refreshed credentials from the vault of the CyberArk Central Credential Provider (CCP).

This guide discusses how to manage a CyberArk Central Credential Provider (CCP).

For information on creating a new CyberArk Central Credential Provider (CCP), refer to [Adding a New Credential Provider in SailPoint](<https://documentation.sailpoint.com/connectors/credential_providers/cyberark_ccp/help/config_new_cred_prov.html>).

## Prerequisites

Before you configure your credential provider, you must consider the following prerequisite items.

- For VA-based Deep Governance connectors, the source and credential provider virtual appliances must be in the same cluster.
- VA-based Deep Governance connectors, SaaS-based Deep Governance, Discovery, and Quick Compliance connectors now support the use of credential providers.
- The Certificate Serial Number should be configured and working. Export the required certificate in PFX format. It should contain all the extended attributes, as well as the public and private keys.
- If Allowed Machines is configured in the CyberArk Access Manager (Self-Hosted) application, then you must add your virtual appliance's IP address into the allowed machines lists.

## Supported Platforms

This credential provider supports the following platforms:

- CyberArk Access Manager Self-Hosted version 14.2 or later
- CyberArk Central Credential Provider (CCP) 14.0.1 or later

# CyberArk Central Secret Path Expressions

Use the path expressions listed in this topic to use the CyberArk Central Credential Provider (CCP) in your source authentication configurations.

Path syntax: `{params required to fetch secret}/{secretKey}`

Secret URL: `secrets://{CyberArk Central Credential Provider Source Name}/{params required to fetch secret}/{secretKey}`

> [!IMPORTANT]
>
> The URL path should always start with the prefix, secrets://. Each URL should be URL-encoded. Each URL attribute in the path is case-sensitive

The CyberArk Central Credential Provider (CCP) fetches secret using REST API. The REST API URL format to fetch secrets is as follows:

```text
https://<IIS_Server_Host_URL>/<WebService_NAME>/api/Accounts?<param1>=<value>&<param2>=<value>&
```

> [!NOTE]
>
> In the provided example, the parameters required to fetch the secret are `<param1>=<value>&<param2>=<value>&`

Secret URL example:

**Before Encoding**

```text
secrets://<CyberArk Central Credential Provider Source>/<Object=Cloud Service-AWS-Salesforce-admin&AppID=Test1>/<Content>
```

Where:

- `<CyberArk Central Credential Provider Source>` - Configured Credential Provider
- `<Object=Cloud Service-AWS-Salesforce-harshaladmin&AppID=Test1>` - Parameters required to fetch secrets
- `<Content>` - Key to retrieve from the secret response

**After Encoding**

```text
secrets://CyberArk%20Central%20Credential%20Provider%20Source/Object%3DCloud%20Service-AWS-Salesforce-admin%26AppID%3DTest1/Content
```

> [!TIP]
>
> Use [urlencoder.org](<https://www.urlencoder.org/>) to encode your URL attributes.

## Prefixes and Suffixes

If any secret paths have a prefix or a suffix, you must append a query parameter to the secret path as follows:

- To add a prefix - `?prefix=<prefix>`. For example, if the secret value returned after evaluation is `LocalAdmin`, but the complete value required by the secret field is `DomainOne\LocalAdmin` then the secret path expression will be as follows to add the required prefix:

  ```text
  secrets://CyberArk%20Central%20Credential%20Provider%20Source/Object%3DCloud%20Service-AWS-Salesforce-admin%26AppID%3DTest1/Content?prefix=DomainOne%5C
  ```
- To add a suffix - `?suffix=<suffix>`. For example, if the secret value returned after evaluation is `localadministrator`, but the complete value required by the secret field is `localadminstrator@sp.com` then the secret path expression will be as follows to add the required suffix:

  ```text
  secrets://CyberArk%20Central%20Credential%20Provider%20Source/Object%3DCloud%20Service-AWS-Salesforce-admin%26AppID%3DTest1/Content?prefix=suffix=%40sp.com
  ```

> [!IMPORTANT]
>
> All input parameters must be encoded.

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

## With certificate authentication configured, the credential provider fails to fetch a secret

**Resolution** - Fetch a secret from the CyberArk Central Credential Provider (CCP) by selecting REST API using tools like Postman or Curl URL. For more information, refer to [Call the Web Service Using REST](<https://docs.cyberark.com/credential-providers/latest/en/content/ccp/calling-the-web-service-using-rest.htm>).

> [!NOTE]
>
> The linked document is not maintained by SailPoint and is subject to change without notice.

## With certificate authentication configured, the credential provider fails to fetch a secret with an SSL Peer Unverified error message

Error message:

```text
javax.net.ssl.SSLPeerUnverifiedException
```

**Resolution 1** - Ensure that the certificate **Subject Alternative Name** is the same as the hostname for the CyberArk Central Credential Provider (CCP) web service. Also, in the CyberArk Central Credential Provider (CCP) application, the URL should be configured with the same hostname.

**Resolution 2** - Disable hostname verification. To disable hostname verification in the Credential Provider, add the following entry to the Credential Provider using the source update API:

```json
[
    {
        "op": "add",
        "path": "/connectorAttributes/allowAllHosts",
        "value": "true"
    }
]
```

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

## Get secret fails with an error code 400, and the CyberArk application uses Allowed Machines authentication

The connector fails to get a secret from the CyberArk Central Credential Provider (CCP), and instead it returns an error code 400. Also, Allowed Machines authentication is configured on the CyberArk Access Manager (Self-Hosted) application.

**Resolution** - Ensure that your virtual appliance's IP address is included in the allowed machines list in the application.