X-Road v6.24 Release Notes: Appendix 1 - New Security Server API and UI
This release introduces a new web-based user interface, built with Vuejs and Vuetify as well as a REST API backend built on Spring Boot.
In total 102 use-cases were re-implemented in the new UI as well as introducing additional authentication and validation functionality to support the new REST API.
More information about the REST API can be found in the Security Server User Guide.
The full OpenAPI 3 description of the API is available here.
Below is a table containing the use-cases that were implemented as part of this work:
| Task | Use case | Implementation |
|---|---|---|
| 1 | Log In to the Graphical User Interface | |
| 2 | Log Out of the Graphical User Interface | |
| 3 | View Security Server Clients | |
| 4 | View the Details of a Security Server Member | |
| 5 | View Certificate | |
| 6 | View the Internal Server Settings of a Security Server Member | |
| 7 | Change a Security Server Member's Internal Connection Type | |
| 8 | Add a Security Server Member's Internal TLS Certificate | |
| 9 | Delete a Security Server Member's Internal TLS Certificate | |
| 10 | View a Security Server Member's Internal TLS Certificate Details | |
| 11 | Export the Internal Certificate of the Security Server | |
| 12 | View the Details of a Security Server Client | |
| 13 | View Certificate | |
| 14 | View the Service Clients of a Security Server Clients | |
| 15 | View the Access Rights of a Service Client | |
| 16 | Add a Service Client to a Security Server Client | |
| 17 | Add Access Rights for a Service Client | |
| 18 | Remove Access Rights from a Service Client | |
| 19 | View the Services of a Security Server Client | |
| 20 | View the WSDLs of a Security Server Client | |
| 21 | Add a WSDL to a Security Server Client | |
| 22 | Edit the Address of a WSDL | |
| 23 | Enable a WSDL | |
| 24 | Disable a WSDL | |
| 25 | Refresh a WSDL | |
| 26 | Delete a WSDL | |
| 27 | View the Access Rights of a Service | |
| 28 | Add Access Rights to a Service | |
| 29 | Remove Access Rights from a Service | |
| 30 | Edit the Address of a Service | |
| 31 | Set the Option to Verify TLS Certificate of a Service | |
| 32 | Edit the Timeout Value of a Service | |
| 33 | Apply a Parameter Value of a Service to All the Services in the WSDL | |
| 34 | View the Internal Server Settings of a Security Server Client | |
| 35 | Change a Security Server Client's Internal Connection Type | |
| 36 | Add a Security Server Client's Internal TLS Certificate | |
| 37 | Delete a Security Server Client's Internal TLS Certificate | |
| 38 | View a Security Server Client's Internal TLS Certificate Details | |
| 39 | Export the Internal Certificate of the Security Server | |
| 40 | View the Local Groups of a Security Server Client | |
| 41 | View the Details of a Local Group | |
| 42 | Add a Local Group for a Security Server Client | |
| 43 | Add Members to a Local Group | |
| 44 | Remove Members from a Local Group | |
| 45 | Edit the Description of a Local Group | |
| 46 | Delete a Local Group | |
| 47 | Add a Client to the Security Server | |
| 48 | Register a Security Server Client | |
| 49 | Unregister a Security Server Client | |
| 50 | Delete a Security Server Client | |
| 51 | Log a User Out of the Graphical User Interface | |
| 52 | View the List of Tokens, Keys and Certificates | |
| 53 | Log in to a Software Token | |
| 54 | Log Out of a Software Token | |
| 55 | Log in to a Hardware Token | |
| 56 | Log Out of a Hardware Token | |
| 57 | View the Details of a Token | |
| 58 | View the Details of a Key | |
| 59 | Edit the Friendly Name of a Token | |
| 60 | Edit the Friendly Name of a Key | |
| 61 | Generate a Key | |
| 62 | Generate a Certificate Signing Request for a Key | |
| 63 | Import a Certificate from a Local File System | |
| 64 | Import a Certificate from a Security Token | |
| 65 | Activate a Certificate | |
| 66 | Disable a Certificate | |
| 67 | Register an Authentication Certificate | |
| 68 | Delete a Key from the System Configuration | |
| 69 | Delete a Key from a Software Token | |
| 70 | Delete a Key from a Hardware Token | |
| 71 | Unregister an Authentication Certificate | |
| 72 | Delete a Certificate or a Certificate Signing Request from the System Configuration | |
| 73 | Delete a Certificate from Hardware Token | |
| 74 | View the Installed Software Version | |
| 75 | View Timestamping Services | |
| 76 | Add a Timestamping Service | |
| 77 | Delete a Timestamping Service | |
| 78 | View the Details of the Internal TLS Certificate | |
| 79 | View the Internal TLS Certificate of the Security Server | |
| 80 | Generate a New Key and Internal TLS Certificate for the Security Server | |
| 81 | Export the Internal TLS Certificate of the Security Server | |
| 82 | View the List of Configuration Backup Files | |
| 83 | Backup Configuration | |
| 84 | Restore Configuration from a Backup File | |
| 85 | Download a Backup File | |
| 86 | Delete a Backup File | |
| 87 | Upload a Backup File | |
| 88 | View the Configuration Anchor Information | |
| 89 | Download the Configuration Anchor File | |
| 90 | Upload a Configuration Anchor File | |
| 91 | Update Configuration | |
| 92 | View the List of Approved Certificate Authorities | |
| 93 | View the Diagnostics Information | |
| 94 | View the Feedback Information | |
| 95 | Add the Initial Configuration for a new Security Server. | |
| 96 | Create a new API key | |
| 97 | Edit an API key | |
| 98 | List API keys | |
| 99 | Revoke an API key | |
| 100 | Call a REST API | |
| 101 | Import the Internal TLS Certificate of the Security Server | |
| 102 | Generate a new CSR for the TLS key of the Security Server |