diff --git a/docs/privilegesecure/25.12/admin/configuration/integrationconnector/integrationpasswordsecure.md b/docs/privilegesecure/25.12/admin/configuration/integrationconnector/integrationpasswordsecure.md index b7374e3c0e..859c9a63a1 100644 --- a/docs/privilegesecure/25.12/admin/configuration/integrationconnector/integrationpasswordsecure.md +++ b/docs/privilegesecure/25.12/admin/configuration/integrationconnector/integrationpasswordsecure.md @@ -1,34 +1,191 @@ --- title: "Password Secure Integration" -description: "Password Secure Integration" +description: "Bring your own vault® (BYOV) for Password Secure" sidebar_position: 30 --- -# Password Secure Integration +# Bring your own vault® (BYOV) for Password Secure Netwrix Privilege Secure now integrates with Netwrix Password Secure to enable centralized, secure management of privileged credentials. This allows organizations to perform actions as specific users using credentials stored and managed in Password Secure, without exposing or manually handling those credentials. The integration streamlines privileged access workflows across both platforms, enhancing security and operational efficiency. +## Password Secure Configuration -## Add a Vault Connector for Password Secure +### Prerequisites -Follow the steps to add a vault connector for Password Secure +Before you begin configuring the integration, you must have a working Password Secure server and Web Application set up. -**Step 1 –** Navigate to the Configuration > Integration Connectors page. +Password Secure should be installed on a separate server from NPS and properly configured prior to integration. It also requires its own database to store credentials. -**Step 2 –** In the Integration Connector list, click the Add Integration Connector icon. +Follow the instructions in the official documentation to install and configure the **Password Secure server** ([installation guide](/docs/passwordsecure/9_3/installation/)) and to start the **Web Application** ([web application guide](/docs/passwordsecure/9_3/configuration/webapplication/web_application)). -![Add HashiCorp Connector Integration](/images/privilegesecure/25.12/accessmanagement/admin/configuration/add/addpassword.png) +Once the server and web application are installed and configured, continue with the steps below. -**Step 3 –** Enter the following information: +### Generate an API Key -- Connector Name – Enter a name to uniquely identify the connector like "Password Secure" -- Connector Description (Optional) – Enter a brief description -- API URL - Enter the address of your Password Secure instance -- Service Account - Enter the Password Secure service account that will be used for the connections. Ensure it has enough privliges to access the desired credentials. +This API key enables NPS to connect to the Password Secure vault. -**Step 4 –** Click the Save icon to create the new integration connector. +**Step 1** - Log in to Password Secure as an administrator. -- Skip Certificate Check – Select to ignore certification warnings when connecting to the server +**Step 2** - Navigate to Tools → API Keys. +![Password Secure API Key Step 1](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step1.webp) -The connector is added. +![Password Secure API Key Step 2](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step2.webp) + +**Step 3** - Click **Create a new API key**. + +![Password Secure API Key Step 3](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step3.webp) + +**Step 4** - Fill out the form: + +- **Name:** (e.g., "NPS Integration") +- **Expires:** Set a validity period (e.g., one year) +- **Access Rights:** Read +- **Access Scopes:** Select "Password" + +![Password Secure API Key Step 4](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step4.webp) + +**Step 5** - Click **Next** to generate the API token and copy it to a safe location (you'll use this in the NPS configuration). + +:::info +Once you create the token, you cannot see it again. If you lose the token, you will need to generate a new one without deleting the old one. A newly generated token without deleting the old one will be valid. +::: + +### Create a New Password (AD User Template) + +If you already have users created with the **AD User** template, you can skip this step. + +The **AD User** template is the standard/default form required for NPS ↔ Password Secure integration. + +:::info +In production environments, you will typically use existing users. +::: + +**Step 1** - Go to **Passwords** → **New Item**. + +**Step 2** - Select **Item Type = AD User**. + +![Password Secure AD User Step 2](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-aduser-step2.webp) + +**Step 3** - Fill out the **New AD User Password** form: + +- **Description:** Short description of the password/user +- **Domain:** Your AD domain +- **Username:** (e.g., "administrator") +- **Password:** (strong password) + +![Password Secure AD User Step 3](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-aduser-step3.webp) + +![Password Secure AD User Step 4](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-aduser-step4.webp) + +**Step 4** - Save the password entry. + +## NPS Configuration + +### Add a Service Account with the Password Secure API Key + +**Step 1** - Log in to the **Netwrix Privilege Secure** admin console. + +**Step 2** - Go to **Configuration > Service Accounts**. + +**Step 3** - Add a new Service Account, using the API key generated in Password Secure: + +- **Name:** (e.g., "NPS Password") +- **Username:** (e.g., "NPS" or any identifier) +- **Password:** Paste the **Password Secure API key** here. + +![NPS Service Account](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-serviceaccount.webp) + +**Step 4** - Save the Service Account. + +### Configure the Password Secure Vault Connector in NPS + +**Step 1** - In the admin console, navigate to **Configuration > Integration Connectors**. + +**Step 2** - Click the **Add Integration Connector** icon. + +**Step 3** - Fill in the connector details: + +- **Connector Name:** (e.g., "NPS Password") +- **Connector Description:** (optional) +- **Connector Template:** Select **Password Secure** from the drop-down. +- **API URL:** Enter the base URL for Password Secure's API (e.g., `https://your-ps-server/api/`) +- **Service Account:** Select the service account you set up earlier (e.g., "NPS Password") +- **Advanced:** Check "Skip Certificate Check". + +![NPS Connector Details](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-connector-details.webp) + +![NPS Connector Advanced](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-connector-advanced.webp) + +**Step 4** - Click **Save** to create the connector. + +### Create an Activity + +**Step 1** - Navigate to **Policy** tab > **Activities**. + +**Step 2** - Click the blue plus icon to create a new activity using the Password Secure connector. + +**Step 3** - Configure the activity: + +- **Name:** Activity name +- **Description:** Activity description +- **Platform:** — Type of platform, which defines the resource +- **Login Account** — The account used to log onto the resource. Select **"Vault"** from the drop-down. +- **Activity Type** — Controls the type of actions for the activity. Select **Interactive** from the drop down menu. +- **Vault Connector** — Displays a list of previously configured connectors. Select the Password Secure connector. + +![NPS Activity Config](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-activity-config.webp) + +![NPS Activity Details](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-activity-details.webp) + +**Step 4** - Click **Save** to create the Activity. + +### Configure a New Policy + +**Step 1** - Navigate to the **Policy** tab > **Access Policy**. + +**Step 2** - Click the **Plus** icon and create a new Policy. See the [Add Access Policy](/docs/privilegesecure/25_12/admin/interface/accesspolicy/addaccesspolicy) topic for additional information. + +**Step 3** - Set the Type as **Resource Based** and select a Connection Profile, with **Default** being sufficient for most setups. + +**Step 4** - Click **Save** to create the Access Policy. + +- **Users:** Assign users to the policy. See the [Users Tab for Resource Based Access Policies](/docs/privilegesecure/25_12/admin/interface/accesspolicy/resourcebasedpolicyt/users) topic for additional information. + +![NPS Policy Config](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-policy-config.webp) + +- **Activity:** Add the activity you created for the Password Secure connector. See the [Activities Tab for Resource Based Access Policies](/docs/privilegesecure/25_12/admin/interface/accesspolicy/resourcebasedpolicyt/activities/) topic for additional information. + +![NPS Policy Resources](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-policy-resources.webp) + +- **Resources:** Add resources for this Activity. See the [Resources Tab for Resource Based Access Policies](/docs/privilegesecure/25_12/admin/interface/accesspolicy/resourcebasedpolicyt/resources/) topic for additional information. + +After completing these steps, you can use the specified user accounts on the defined resources. + +This setup is ideal for scenarios where a single account is used across multiple resources but needs to be managed securely with credentials stored in Password Secure. + +## System Diagram: Vault Login Activity with Password Secure Integration + +When a vault login-type activity is initiated and the selected vault is of type **PasswordSecure**, the following process occurs: + +1. **Action Service** triggers the start of the activity. +2. The **Action Service Worker** takes over and initiates a credential checkout request. +3. The **VaultConnector PasswordSecure module** receives the request and calls the appropriate cmdlet (**Get-VaultCredential**). +4. The cmdlet logs in to Password Secure using the configured **API Key**. +5. The module searches for the specified Domain\User in Password Secure. +6. If the user's password is found, the credential is returned to the requester. +7. If the user's password is not found, a null value is returned. + +![Password Secure Vault Diagram](/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-vault-diagram.webp) + +:::warning +Always verify configurations and permissions, especially when integrating with systems like AD and using specific user accounts for critical operations. +::: + +## SDK Compatibility and Updates + +- The integration uses Password Secure SDK DLL files and the Password Secure API for communication. +- The DLLs shipped with NPS are compatible with Password Secure versions 9.2.0 and above +- If you need to use a newer version of Password Secure, manually replace (“hot-swap”) the DLLs in: +`C:\Program Files\Stealthbits\PAM\ActionServiceWorker\PsrApi` +- Updated DLLs will be included in new NPS product releases, but for immediate compatibility with the latest Password Secure releases, manual updates may be required. The SDK can be downloaded from the Password Secure Customer Information System. diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-activity-config.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-activity-config.webp new file mode 100644 index 0000000000..0e35e5654c Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-activity-config.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-activity-details.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-activity-details.webp new file mode 100644 index 0000000000..99ce7e5f2f Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-activity-details.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-connector-advanced.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-connector-advanced.webp new file mode 100644 index 0000000000..8839eafc5a Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-connector-advanced.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-connector-details.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-connector-details.webp new file mode 100644 index 0000000000..0003b38fd9 Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-connector-details.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-policy-config.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-policy-config.webp new file mode 100644 index 0000000000..4382d83119 Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-policy-config.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-policy-resources.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-policy-resources.webp new file mode 100644 index 0000000000..39fd00774a Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-policy-resources.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-serviceaccount.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-serviceaccount.webp new file mode 100644 index 0000000000..a6cae60d73 Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/nps-serviceaccount.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-aduser-step2.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-aduser-step2.webp new file mode 100644 index 0000000000..9592e86282 Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-aduser-step2.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-aduser-step3.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-aduser-step3.webp new file mode 100644 index 0000000000..a622082709 Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-aduser-step3.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-aduser-step4.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-aduser-step4.webp new file mode 100644 index 0000000000..0695ca9dce Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-aduser-step4.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step1.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step1.webp new file mode 100644 index 0000000000..c716453364 Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step1.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step2.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step2.webp new file mode 100644 index 0000000000..3b05aa15b3 Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step2.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step3.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step3.webp new file mode 100644 index 0000000000..51079cd7d5 Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step3.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step4.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step4.webp new file mode 100644 index 0000000000..7a35a7638d Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-api-step4.webp differ diff --git a/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-vault-diagram.webp b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-vault-diagram.webp new file mode 100644 index 0000000000..c6e7d45c87 Binary files /dev/null and b/static/images/privilegesecure/25.12/accessmanagement/admin/configuration/integrationdetails/ps-vault-diagram.webp differ