Use cases
Initial setup after installation
The instance may participate in one or more federations. "Federation" is a generic term here, encompassing SAML federations, a collection of OIDC parties, or an intra-organisation set of entities (internal federation). The instance will have an identity as either a service provider (SAML SP or OIDC RP), an identity provider (SAML IdP or OIDC OP), or both. These roles will define the deployment’s identity.
- After deployment, the "My Metadata" screen is initially empty.
- With an "Add Role" (we might rename it if a better suggestion arises) button, the user can select 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 for the chosen role.
- If the SAML IdP role is selected, a checklist of supported entity categories will be available:
- Research & Scholarship
- Anonymous Access (v2)
- Pseudonymous Access (v2)
- Personalised Access (v2)
- If the SAML SP role is selected, the following settings/attributes are available:
- Research & Scholarship
- Code of Conduct
Adding remote entity metadata
Context: The user can add metadata for the entities this deployment should know and trust.
- On the metadata management screen, the user presses "Add remote entity metadata."
- The available options depend on the roles configured:
- If the instance has the SAML IdP role, the user can add SAML SP metadata from XML or a URL to download.
- If the instance has the OIDC OP role, the user can add a redirect URI, name, and description (the instance provisions the client ID and client secret).
- If the instance has the SAML SP role, the user can add SAML IdP metadata.
- If the instance has the OIDC RP role, the user can add an OP.
Adding metadata source
Context: You can add an MDQ source and trust everything retrieved from it. In a future, more advanced version, you may also be able to add an OIDFed intermediate authority.
TBD
Deactivate/activate remote entity
- On the metadata screen, entities already added to the instance should be able to be deactivated and reactivated (via a button or checkbox).
Configure proxy mode
Context: If you added at least one of (SAML IdP, OIDC OP) and one of (SAML SP, OIDC RP), then you can act as a proxy. In this case, a configuration option that was previously unavailable ("grey") becomes available as 'Proxy configuration.'
Here, you can add identity and profile attribute mappings.
Edit data sources and data release (not MVP)
Context: This applies only if a SAML IdP or OIDC OP role is enabled.
Note: For the MVP, custom attribute release per remote entity is not implemented. Instead, there is a generic setup that may still be conditional on remote entity categories (e.g., CoCo gets more {attributes?}).
- On the Configuration screen, the user adds a data source:
- SQL
- LDAP
- Other...
- The user adds connection data for the data source.
- The user adds attribute mappings for the data source, e.g., DB field → attribute name.
Information architecture
Dashboard
- Overview of metadata management status.
- Quick access to recent activities and common tasks.
- Configuration
- Configuration of the local instance not related to remote entities.
- Attribute sources
- Configuration of the local instance not related to remote entities.
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 the 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 → visual components
Navigation
- Top Navigation Bar: 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 cancelling, 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 synchronisation.
User Profile and Settings
- Profile Dropdown: For user account management, logout, and settings.
- Settings Page: For configuring user preferences and system settings.