11---
2- title : " migration_guide "
3- description : " migration_guide "
2+ title : " Migration guide "
3+ description : " Migration guide "
44sidebar_position : 10
55---
66
7- ## Migration Guide: Breaking Changes - API Login
7+ ## Breaking Changes - API Login
88
9- Overview: We've enhanced the login authentication process to offer a more dynamic and secure
9+ Overview: The login authentication process was enhanced to offer a more dynamic and secure
1010experience. This update introduces a new method of authentication, effective for servers from
1111version 8.12 onward.
1212
13- ::: warning
14- Important Update: Starting from server version 9.0, the previous login method will no
15- longer be functional. Users must adopt the new authentication approach provided in our API to
13+ ** CAUTION:** Important Update: Starting from server version 9.0, the previous login method will no
14+ longer be functional. Users must adopt the new authentication approach provided in the API to
1615continue accessing the services.
17- :::
1816
17+ #### Why the change was done
1918
20- #### Why was this change done?
21-
22- Since version 8.12, our server and clients are supporting authentication methods other than
23- passwords. Therefore, we have introduced a two-step authentication in our server and our clients.
24- After entering the username, the server is asked for the main factor for the authentication.With the
25- release of version 8.12, our server and client applications have expanded their support for
19+ Since version 8.12, the Password Secure server and clients are supporting authentication methods other than
20+ passwords. Therefore, a two-step authentication was introduced in the server and the clients.
21+ After entering the username, the server asks for the main factor for the authentication. With the
22+ release of version 8.12, the server and client applications have expanded their support for
2623authentication methods beyond traditional passwords. Consequently, to enhance security, a two-step
27- authentication process has been introduced within both our server and client environments. This
24+ authentication process has been introduced within both the server and client environments. This
2825process entails the user inputting their username, followed by a request to the server for the
29- primary authentication factor. Notably, this change was not initially implemented in our APIs.
26+ primary authentication factor. Notably, this change wasn't initially implemented in the APIs.
3027
31- To align our systems with enhanced security standards, we have undertaken the implementation of the
32- new PBKDF2 hashing iteration count. As part of this transition, we have made the strategic decision
33- to discontinue the use of the old authentication endpoint. Subsequently, we have diligently
34- integrated the new authentication mechanism into our APIs to ensure a consistent and secure user
35- experience.
28+ To align the systems with enhanced security standards, the implementation of the new PBKDF2 hashing
29+ iteration count was done. As part of this transition, the strategic decision
30+ to discontinue the use of the old authentication endpoint was made. Subsequently, the new authentication
31+ mechanism was integrated into the APIs to ensure a consistent and secure user experience.
3632
3733Transition details:
3834
3935- ** Old Method Deprecation** : The previous login method is deprecated and no longer operational with
4036 servers of version 9.0.
41- - ** New Authentication Requirement:** To access our services, users must switch to the updated
42- authentication method in our APIs, compatible with servers from version 8.12 onward. Versions
37+ - ** New Authentication Requirement:** To access Password Secure services, users must switch to the updated
38+ authentication method in the APIs, compatible with servers from version 8.12 onward. Versions
4339 older than 8.12 are no longer operational with the API. If you're using such an old version,
44- please use the old API.
40+ use the old API.
4541
46- ::: warning
47- Action Required: Ensure that your server version is 8.12 or later to implement the new
48- authentication method and seamlessly access our services. Update your integration with the API to
42+ ** CAUTION:** Action Required: Ensure that your server version is 8.12 or later to implement the new
43+ authentication method and access the services. Update your integration with the API to
4944incorporate the revised login interface and maintain uninterrupted service access.
50- :::
51-
5245
5346Below are code examples for the previous and updated authentication methods.
5447
5548#### C#
5649
57- ** Previous authentication method (deprecated)**
50+ Previous authentication method (deprecated)
5851
5952```
6053var database = "your-database";
@@ -75,7 +68,7 @@ while (mfaRequest != null) {
7568}
7669```
7770
78- ** New authentication method (required for version 9.0 onwards)**
71+ New authentication method (required for version 9.0 onwards)
7972
8073```
8174var database = "your-database";
@@ -97,7 +90,7 @@ while (!authenticationFlow.IsAuthenticated) {
9790
9891#### JavaScript
9992
100- ** Previous authentication method (deprecated)**
93+ Previous authentication method (deprecated)
10194
10295```
10396const database = 'your-database'
@@ -113,7 +106,7 @@ while (mfaRequest) {
113106}
114107```
115108
116- ** New authentication method (required for version 9.0 onwards)**
109+ New authentication method (required for version 9.0 onwards)
117110
118111```
119112const database = 'your-database'
@@ -135,11 +128,11 @@ while (!psrApi.authenticationManagerV2.isAuthenticated) {
135128
136129The API object is created as always: by passing the server address to the constructor.
137130
138- After that, the implementation differs slightly between C# and JavaScript. For C#, we’re getting the
139- authentication flow via ** psrApi.AuthenticationManagerV2.StartNewAuthentication("your-database",
131+ After that, the implementation differs slightly between C# and JavaScript. For C#, the authentication flow
132+ can be accessed via ** psrApi.AuthenticationManagerV2.StartNewAuthentication("your-database",
140133"your-username");** . On the resulting instance, the asynchronous method ** StartLogin()** needs to be
141- called and awaited. Using the JavaScript API, we can directly call and await the
142- ** psrApi.authenticationManagerV2.startLogin('your-database', 'your-username) ** method .
134+ called and awaited. Using the JavaScript API, the ** psrApi.authenticationManagerV2.startLogin('your-database', 'your-username) **
135+ method can be called directly .
143136
144137After this, you must call the ** GetNextRequirement()** method. The result contains the requirements
145138the user has to fill in. It usually contains a “Fields“ list, where the “Value” needs to be set. The
@@ -156,7 +149,7 @@ in the fields, and send the requirement via **authenticate** method.
156149As soon as the authentication is completed, the ** psrApi.authenticationManagerV2.isAuthenticated**
157150property is set to true.
158151
159- For any queries or assistance in transitioning to the new authentication method, please refer to our
160- updated documentation or reach out to our support team.
152+ For any queries or assistance in transitioning to the new authentication method, refer to the
153+ updated documentation or reach out to the support team.
161154
162- Thank you for your cooperation as we continue to improve security and usability within our API.
155+ Thank you for your cooperation in continuing improving security and usability within the API.
0 commit comments