Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/contend_add.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ body:
- Password Secure 9.1
- Password Secure 9.2
- Password Secure 9.3
- Password Secure 26.3
- PingCastle
- Platform Governance for NetSuite
- Platform Governance Flashlight for NetSuite
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/content_fix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ body:
- Password Secure 9.1
- Password Secure 9.2
- Password Secure 9.3
- Password Secure 26.3
- PingCastle
- Platform Governance for NetSuite
- Platform Governance Flashlight for NetSuite
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ All logos and icons are managed in the image management. They can then be linked
corresponding data records. The images are then displayed in the Basic view as well as in the list
view of the client.

![Icon/logos in NPS](/images/passwordsecure/9.1/configuration/advanced_view/mainmenu/extras/image_management/installation_with_parameters_106-en.webp)
![Icon/logos in NPWS](/images/passwordsecure/9.1/configuration/advanced_view/mainmenu/extras/image_management/installation_with_parameters_106-en.webp)

## Relevant rights

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ There are 2 possibilities here:

1. username like the local user (e.g. administrator)

2. domain and username (e.g. nps\administrator)
2. domain and username (e.g. npws\administrator)

![image4](/images/passwordsecure/9.1/configuration/basic_view/start_and_login/image4.webp)

Expand Down
73 changes: 33 additions & 40 deletions docs/passwordsecure/9.1/configuration/sdkapi/migration_guide.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,53 @@
---
title: "migration_guide"
description: "migration_guide"
title: "Migration guide"
description: "Migration guide"
sidebar_position: 10
---

## Migration Guide: Breaking Changes - API Login
## Breaking Changes - API Login

Overview: We've enhanced the login authentication process to offer a more dynamic and secure
Overview: The login authentication process was enhanced to offer a more dynamic and secure
experience. This update introduces a new method of authentication, effective for servers from
version 8.12 onward.

:::warning
Important Update: Starting from server version 9.0, the previous login method will no
longer be functional. Users must adopt the new authentication approach provided in our API to
**CAUTION:** Important Update: Starting from server version 9.0, the previous login method will no
longer be functional. Users must adopt the new authentication approach provided in the API to
continue accessing the services.
:::

#### Why the change was done

#### Why was this change done?

Since version 8.12, our server and clients are supporting authentication methods other than
passwords. Therefore, we have introduced a two-step authentication in our server and our clients.
After entering the username, the server is asked for the main factor for the authentication.With the
release of version 8.12, our server and client applications have expanded their support for
Since version 8.12, the Password Secure server and clients are supporting authentication methods other than
passwords. Therefore, a two-step authentication was introduced in the server and the clients.
After entering the username, the server asks for the main factor for the authentication. With the
release of version 8.12, the server and client applications have expanded their support for
authentication methods beyond traditional passwords. Consequently, to enhance security, a two-step
authentication process has been introduced within both our server and client environments. This
authentication process has been introduced within both the server and client environments. This
process entails the user inputting their username, followed by a request to the server for the
primary authentication factor. Notably, this change was not initially implemented in our APIs.
primary authentication factor. Notably, this change wasn't initially implemented in the APIs.

To align our systems with enhanced security standards, we have undertaken the implementation of the
new PBKDF2 hashing iteration count. As part of this transition, we have made the strategic decision
to discontinue the use of the old authentication endpoint. Subsequently, we have diligently
integrated the new authentication mechanism into our APIs to ensure a consistent and secure user
experience.
To align the systems with enhanced security standards, the implementation of the new PBKDF2 hashing
iteration count was done. As part of this transition, the strategic decision
to discontinue the use of the old authentication endpoint was made. Subsequently, the new authentication
mechanism was integrated into the APIs to ensure a consistent and secure user experience.

Transition details:

- **Old Method Deprecation**: The previous login method is deprecated and no longer operational with
servers of version 9.0.
- **New Authentication Requirement:** To access our services, users must switch to the updated
authentication method in our APIs, compatible with servers from version 8.12 onward. Versions
- **New Authentication Requirement:** To access Password Secure services, users must switch to the updated
authentication method in the APIs, compatible with servers from version 8.12 onward. Versions
older than 8.12 are no longer operational with the API. If you're using such an old version,
please use the old API.
use the old API.

:::warning
Action Required: Ensure that your server version is 8.12 or later to implement the new
authentication method and seamlessly access our services. Update your integration with the API to
**CAUTION:** Action Required: Ensure that your server version is 8.12 or later to implement the new
authentication method and access the services. Update your integration with the API to
incorporate the revised login interface and maintain uninterrupted service access.
:::


Below are code examples for the previous and updated authentication methods.

#### C#

**Previous authentication method (deprecated)**
Previous authentication method (deprecated)

```
var database = "your-database";
Expand All @@ -75,7 +68,7 @@ while (mfaRequest != null) {
}
```

**New authentication method (required for version 9.0 onwards)**
New authentication method (required for version 9.0 onwards)

```
var database = "your-database";
Expand All @@ -97,7 +90,7 @@ while (!authenticationFlow.IsAuthenticated) {

#### JavaScript

**Previous authentication method (deprecated)**
Previous authentication method (deprecated)

```
const database = 'your-database'
Expand All @@ -113,7 +106,7 @@ while (mfaRequest) {
}
```

**New authentication method (required for version 9.0 onwards)**
New authentication method (required for version 9.0 onwards)

```
const database = 'your-database'
Expand All @@ -135,11 +128,11 @@ while (!psrApi.authenticationManagerV2.isAuthenticated) {

The API object is created as always: by passing the server address to the constructor.

After that, the implementation differs slightly between C# and JavaScript. For C#, we’re getting the
authentication flow via **psrApi.AuthenticationManagerV2.StartNewAuthentication("your-database",
After that, the implementation differs slightly between C# and JavaScript. For C#, the authentication flow
can be accessed via **psrApi.AuthenticationManagerV2.StartNewAuthentication("your-database",
"your-username");**. On the resulting instance, the asynchronous method **StartLogin()** needs to be
called and awaited. Using the JavaScript API, we can directly call and await the
**psrApi.authenticationManagerV2.startLogin('your-database', 'your-username)** method.
called and awaited. Using the JavaScript API, the **psrApi.authenticationManagerV2.startLogin('your-database', 'your-username)**
method can be called directly.

After this, you must call the **GetNextRequirement()** method. The result contains the requirements
the user has to fill in. It usually contains a “Fields“ list, where the “Value” needs to be set. The
Expand All @@ -156,7 +149,7 @@ in the fields, and send the requirement via **authenticate** method.
As soon as the authentication is completed, the **psrApi.authenticationManagerV2.isAuthenticated**
property is set to true.

For any queries or assistance in transitioning to the new authentication method, please refer to our
updated documentation or reach out to our support team.
For any queries or assistance in transitioning to the new authentication method, refer to the
updated documentation or reach out to the support team.

Thank you for your cooperation as we continue to improve security and usability within our API.
Thank you for your cooperation in continuing improving security and usability within the API.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_position: 60
With the update to the version 8.16.0 the Netwrix Password Secure Server Encryption Certificate will
be added automatically.

![NPS Server Encryption](/images/passwordsecure/9.1/configuration/server_manager/certificates/nps-server-encryption_1014x771.webp)
![NPWS Server Encryption](/images/passwordsecure/9.1/configuration/server_manager/certificates/nps-server-encryption_1014x771.webp)

This certificate is important if you will activate an offline license. In future there will be more
features for which this certificate is relevant.
Expand Down
4 changes: 2 additions & 2 deletions docs/passwordsecure/9.1/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ this challenge in private settings. In a large corporate environment, adequately

## Scalability

The scalability of Netwrix Password Secure (NPS) makes it suitable for use in SMEs, large
The scalability of Netwrix Password Secure (NPWS) makes it suitable for use in SMEs, large
companies, and global corporations. The flexibility required for this task is the driving factor
behind the development to meet the ever-changing requirements of modern and safety-conscious
companies. NPS is a software solution for companies that want to effectively manage
companies. It's is a software solution for companies that want to effectively manage
security-relevant data such as passwords, documents, or certificates at a very high encryption
level.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_position: 40
## Installing the add-on

The Safari Add-on can be downloaded from the following link:
[Add-on Safari](https://download.passwordsafe.de/v9/Netwrix_Password_Secure-9.0.3.dmg).
[Add-on Safari](https://download.passwordsafe.de/v9/Netwrix_Password_Secure-9.1.3.dmg).

To install it, simply double-click on the downloaded file. A window will open where you then only
need to drag and drop the Netwrix Password Secure logo onto the applications.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ There are 2 possibilities here:

1. username like the local user (e.g. administrator)

2. domain and username (e.g. nps\administrator)
2. domain and username (e.g. npws\administrator)

![image4](/images/passwordsecure/9.2/configuration/basic_view/start_and_login/image4.webp)

Expand Down
55 changes: 27 additions & 28 deletions docs/passwordsecure/9.2/configuration/sdkapi/migration_guide.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,46 @@
---
title: "migration_guide"
description: "migration_guide"
title: "Migration guide"
description: "Migration guide"
sidebar_position: 10
---

## Migration Guide: Breaking Changes - API Login
## Breaking Changes - API Login

Overview: We've enhanced the login authentication process to offer a more dynamic and secure
Overview: The login authentication process was enhanced to offer a more dynamic and secure
experience. This update introduces a new method of authentication, effective for servers from
version 8.12 onward.

**CAUTION:** Important Update: Starting from server version 9.0, the previous login method will no
longer be functional. Users must adopt the new authentication approach provided in our API to
longer be functional. Users must adopt the new authentication approach provided in the API to
continue accessing the services.

#### Why was this change done?
#### Why the change was done

Since version 8.12, our server and clients are supporting authentication methods other than
passwords. Therefore, we have introduced a two-step authentication in our server and our clients.
After entering the username, the server is asked for the main factor for the authentication.With the
release of version 8.12, our server and client applications have expanded their support for
Since version 8.12, the Password Secure server and clients are supporting authentication methods other than
passwords. Therefore, a two-step authentication was introduced in the server and the clients.
After entering the username, the server asks for the main factor for the authentication. With the
release of version 8.12, the server and client applications have expanded their support for
authentication methods beyond traditional passwords. Consequently, to enhance security, a two-step
authentication process has been introduced within both our server and client environments. This
authentication process has been introduced within both the server and client environments. This
process entails the user inputting their username, followed by a request to the server for the
primary authentication factor. Notably, this change was not initially implemented in our APIs.
primary authentication factor. Notably, this change wasn't initially implemented in the APIs.

To align our systems with enhanced security standards, we have undertaken the implementation of the
new PBKDF2 hashing iteration count. As part of this transition, we have made the strategic decision
to discontinue the use of the old authentication endpoint. Subsequently, we have diligently
integrated the new authentication mechanism into our APIs to ensure a consistent and secure user
experience.
To align the systems with enhanced security standards, the implementation of the new PBKDF2 hashing
iteration count was done. As part of this transition, the strategic decision
to discontinue the use of the old authentication endpoint was made. Subsequently, the new authentication
mechanism was integrated into the APIs to ensure a consistent and secure user experience.

Transition details:

- **Old Method Deprecation**: The previous login method is deprecated and no longer operational with
servers of version 9.0.
- **New Authentication Requirement:** To access our services, users must switch to the updated
authentication method in our APIs, compatible with servers from version 8.12 onward. Versions
- **New Authentication Requirement:** To access Password Secure services, users must switch to the updated
authentication method in the APIs, compatible with servers from version 8.12 onward. Versions
older than 8.12 are no longer operational with the API. If you're using such an old version,
please use the old API.
use the old API.

**CAUTION:** Action Required: Ensure that your server version is 8.12 or later to implement the new
authentication method and seamlessly access our services. Update your integration with the API to
authentication method and access the services. Update your integration with the API to
incorporate the revised login interface and maintain uninterrupted service access.

Below are code examples for the previous and updated authentication methods.
Expand Down Expand Up @@ -129,11 +128,11 @@ while (!psrApi.authenticationManagerV2.isAuthenticated) {

The API object is created as always: by passing the server address to the constructor.

After that, the implementation differs slightly between C# and JavaScript. For C#, we’re getting the
authentication flow via **psrApi.AuthenticationManagerV2.StartNewAuthentication("your-database",
After that, the implementation differs slightly between C# and JavaScript. For C#, the authentication flow
can be accessed via **psrApi.AuthenticationManagerV2.StartNewAuthentication("your-database",
"your-username");**. On the resulting instance, the asynchronous method **StartLogin()** needs to be
called and awaited. Using the JavaScript API, we can directly call and await the
**psrApi.authenticationManagerV2.startLogin('your-database', 'your-username)** method.
called and awaited. Using the JavaScript API, the **psrApi.authenticationManagerV2.startLogin('your-database', 'your-username)**
method can be called directly.

After this, you must call the **GetNextRequirement()** method. The result contains the requirements
the user has to fill in. It usually contains a “Fields“ list, where the “Value” needs to be set. The
Expand All @@ -150,7 +149,7 @@ in the fields, and send the requirement via **authenticate** method.
As soon as the authentication is completed, the **psrApi.authenticationManagerV2.isAuthenticated**
property is set to true.

For any queries or assistance in transitioning to the new authentication method, please refer to our
updated documentation or reach out to our support team.
For any queries or assistance in transitioning to the new authentication method, refer to the
updated documentation or reach out to the support team.

Thank you for your cooperation as we continue to improve security and usability within our API.
Thank you for your cooperation in continuing improving security and usability within the API.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_position: 60
With the update to the version 8.16.0 the Netwrix Password Secure Server Encryption Certificate will
be added automatically.

![NPS Server Encryption](/images/passwordsecure/9.2/configuration/server_manager/certificates/nps-server-encryption_1014x771.webp)
![NPWS Server Encryption](/images/passwordsecure/9.2/configuration/server_manager/certificates/nps-server-encryption_1014x771.webp)

This certificate is important if you will activate an offline license. In future there will be more
features for which this certificate is relevant.
Expand Down
4 changes: 2 additions & 2 deletions docs/passwordsecure/9.2/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ this challenge in private settings. In a large corporate environment, adequately

## Scalability

The scalability of Netwrix Password Secure (NPS) makes it suitable for use in SMEs, large
The scalability of Netwrix Password Secure (NPWS) makes it suitable for use in SMEs, large
companies, and global corporations. The flexibility required for this task is the driving factor
behind the development to meet the ever-changing requirements of modern and safety-conscious
companies. NPS is a software solution for companies that want to effectively manage
companies. It's is a software solution for companies that want to effectively manage
security-relevant data such as passwords, documents, or certificates at a very high encryption
level.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_position: 40
## Installing the add-on

The Safari Add-on can be downloaded from the following link:
[Add-on Safari](https://download.passwordsafe.de/v9/Netwrix_Password_Secure-9.0.3.dmg).
[Add-on Safari](https://releases.netwrix.com/products/passwordsecure/9.2/passwordsecure-MacApp-9.2.6.33415.dmg).

To install it, simply double-click on the downloaded file. A window will open where you then only
need to drag and drop the Netwrix Password Secure logo onto the applications.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ All logos and icons are managed in the image management. They can then be linked
corresponding data records. The images are then displayed in the Basic view as well as in the list
view of the client.

![Icon/logos in NPS](/images/passwordsecure/9.2/configuration/advanced_view/mainmenu/extras/image_management/installation_with_parameters_106-en.webp)
![Icon/logos in NPWS](/images/passwordsecure/9.2/configuration/advanced_view/mainmenu/extras/image_management/installation_with_parameters_106-en.webp)

## Relevant rights

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ There are 2 possibilities here:

1. username like the local user (e.g. administrator)

2. domain and username (e.g. nps\administrator)
2. domain and username (e.g. npws\administrator)

![image4](/images/passwordsecure/9.2/configuration/basic_view/start_and_login/image4.webp)

Expand Down
Loading
Loading