Use cases
- Initial setup after installation
Context: The proxy will participate in multiple federations (federation being a generic term here, either meaning SAML federations as well as a bunch of OIDC parties, as well as intra-organization set of entities (internal federation)). This fact makes it a proxy. Therefore it will have an identity as a service provider (SAML SP or OIDC RP) as well as an identity provider (SAML IdP or OIDC OP).
- After the deployment, the "My Metadata" screen is empty.
- With an "Add Role" (we might rename it if there is a better suggestion) button the user selects one of the following: SAML IdP, OIDC OP, SAML SP, OIDC RP.
- Regardless of what is selected, the user can set up a Display Name and a Logo
- If SAML IdP is selected, there is a checklist of supported entity categories
- TBD
Information architecture
Dashboard
- Overview of metadata management status.
- Quick access to recent activities and common tasks.
Metadata Management
- Federation-level: Interface to add/edit federation-wide metadata.
- Individual SPs/IdPs: Interface to add/edit metadata for individual SPs/IdPs, with options for manual entry or file import.
Relation Management
- Select SP/IdP: Dropdown or search functionality to select an SP/IdP.
- Activate SP/IdP: Toggle to activate selected SP/IdP.
- Attribute Release Policy (SP): ?Options to configure REFEDs entity categories for SPs.
- Requested Attributes (IDP): ?Options to select requested entity categories for IdPs.
My Metadata
- Display Name: Field to enter/display the name of the proxy.
- ?Supported Entity Categories: Checklist or dropdown to select supported categories.
- Logo: Upload functionality to add a logo.
Common actions → components
Navigation
- Top Navigation Bar: Includes links to main sections like Dashboard, Metadata Management, Relation Management, and My Metadata.
- Sidebar Navigation: For quick access to subsections within the main areas.
Forms and Input Fields
- Text Input Fields: For entering metadata, display names, and other textual information.
- Dropdown Menus: For selecting options such as entity categories, SPs, and IdPs.
- Checkboxes and Radio Buttons: For selecting multiple or single options, such as supported entity categories and requested attributes.
- File Upload Fields: For importing metadata files or uploading logos.
- Toggle Switches: For activating or deactivating SPs/IdPs.
Buttons and Actions
- Primary Action Buttons: For saving, adding, or submitting forms.
- Secondary Action Buttons: For canceling, editing, or deleting actions.
- Icon Buttons: For quick actions like editing or deleting items in a list.
Tables and Lists
- Data Tables: For displaying lists of SPs/IdPs, including columns for relevant metadata and actions.
- Paginated Lists: For managing large datasets with navigation controls.
- Expandable Rows: For viewing detailed information about a specific SP/IdP within a table.
Modals and Dialogs
- Confirmation Dialogs: For confirming actions like deletions or important changes.
- Form Modals: For adding or editing metadata in a focused environment.
Search and Filter
- Search Bars: For finding specific SPs/IdPs or metadata entries.
- Filter Options: For narrowing down lists based on criteria like entity categories or active status.
Feedback and Notifications
- Toast Notifications: For temporary messages about actions (e.g., "Metadata saved successfully").
- Error Messages: Inline or modal messages for form validation errors or system issues.
- Success Messages: Inline or modal messages confirming successful actions.
Dashboard Widgets
- Summary Cards: For displaying key metrics and statuses (e.g., total SPs, active IdPs).
- Activity Feeds: For showing recent actions and changes.
Visual Indicators
- Status Badges: For indicating the status of SPs/IdPs (e.g., active, inactive).
- Progress Bars: For showing the progress of actions like file uploads or metadata synchronization.
User Profile and Settings
- Profile Dropdown: For user account management, logout, and settings.
- Settings Page: For configuring user preferences and system settings.