Onboarding Service Provider Dashboard/Management Board

[jjeroch]

Summary:

Develop an enhanced dashboard for the Onboarding Service Provider (OSP) to efficiently manage connected Identity Providers (IdPs), companies, and other relevant entities. This dashboard aims to provide a comprehensive, user-friendly interface that enables OSPs to view, control, and analyze various aspects of their service, improving overall administration and user experience.

Description:

The Onboarding Service Provider Dashboard is a crucial tool for OSPs to manage their ecosystem which includes Identity Providers (IdPs), associated companies, and other integrations. The dashboard should offer intuitive navigation, advanced features for management, and analytical tools to monitor activity and performance. This epic captures all the necessary features and improvements to build a robust dashboard.

User Stories:

1. User Story: Dashboard Access and Security

   • As an OSP administrator,
   • I want secure login and authentication features
   • So that only authorized users can access the OSP dashboard.

2. User Story: Manage Identity Providers (IdPs)

   • As an OSP administrator,
   • I want to add, remove, and edit IdPs
   • So that the dashboard remains up-to-date with all connected IdPs.

3. User Story: View Registration triggered Companies and their registration status

   • As an OSP administrator,
   • I want to view detailed profiles of all companies connected through the IdPs
   • So that I can get all necessary information.

4. User Story: Alerts and Notifications

   • As an OSP administrator,
   • I want to set up and receive custom alerts for specific events or anomalies
   • So that I am immediately informed about important or urgent issues.

Acceptance Criteria:

• All features should be accessible via a clean, intuitive interface that requires minimal training.
• The system should provide real-time data with minimal latency.
• Support for logging and detailed error messages should be implemented for troubleshooting.

Tasks:

• Design the overall architecture of the dashboard including backend and frontend components.
• Develop frontend interfaces for managing IdPs, companies, and integrations.
• Create backend services to handle data management and business logic.
• Test all functionalities in various scenarios to ensure reliability and security.

Dependencies:

• n/a

---

Test Cases

User Story: Manage Identity Providers (IdPs)

Test Case 1: Add an IdP (existing TC, function is now additional available via the OSP Board)

• Objective: Verify that the OSP administrator/IT Admin can add a new IdP.
• Steps:
  1. Navigate to the IdP management section.
  2. Click on the 'Add IdP' button.
  3. Fill in the necessary details and submit.
• Expected Result: The new IdP appears on the list of IdPs.

Test Case 2: Remove an IdP (existing TC, function is now additional available via the OSP Board)

• Objective: Ensure that the OSP administrator/IT Admin can remove an existing IdP.
• Steps:
  1. Navigate to the IdP management section.
  2. Select an IdP to remove.
  3. Click the 'Remove' button and confirm the action.
• Expected Result: The IdP is removed from the list.

Test Case 3: Edit an IdP (existing TC, function is now additional available via the OSP Board)

• Objective: Confirm that the OSP administrator/IT Admin can edit IdP details.
• Steps:
  1. Navigate to the IdP management section.
  2. Select an IdP to edit.
  3. Click the 'Edit' button, make changes, and submit.
• Expected Result: The IdP details are updated in the list.

User Story: View Customer Companies and their registration status

Test Case 4: View Company Profile

• Objective: Verify that the OSP administrator/IT Admin can view owned customer companies and their registration status.
• Steps:
  1. Navigate to the company management section.
  2. Click on a "companies" to view registration triggered 3rd party companies and their status.
• Expected Result: The company's and their status of the registration is displayed.

User Story: Alerts and Notifications

Test Case 5: Setup Custom Alerts

• Objective: Confirm that the OSP administrator can set up custom alerts.
• Steps:
  1. Navigate to the OSP Management Board
  2. Setup the callback function (endpoint and authentication details)
  3. Save the alert configuration.
• Expected Result: The custom alert is saved and active.

Test Case 6: Receive Alerts

• Objective: Verify that alerts are received when the configured events occur.
• Steps:
  1. Trigger an event that meets the custom alert criteria.
• Expected Result: The OSP administrator receives the alert notification.

---

Linked Tickets

• sig#809: Management Page for Onboarding Service Providers portal-frontend#541
• sig#809: GET Endpoint for Retrieving Onboarded OSP Companies and Their Statuses portal-backend#808
• sig#809: API Enhancement OSP Customer Management - GET /api/administration/registration/network/companies Endpoint portal-backend#850

[jjeroch]

• Test Cases added ✅

[MaximilianHauer]

adjustment that will follow with 24.12. development:

• sig#809 - enhance permission logic for OSP management board  portal-iam#186
• sig#809 - Implement permission for Onboarding Service Provider endpoints  portal-backend#994
• sig#809 - enhance permission validation for Onboarding Service Provider portal-frontend#1108