You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Use cases

  • Initial setup after installation

Context: The instance may participate in at least one, potentially 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). Therefore it will have an identity as either service provider (SAML SP or OIDC RP) or identity provider (SAML IdP or OIDC OP) or both. This or these will be the deployment's role(s).

  1. After the deployment, the "My Metadata" screen is empty.
  2. 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.
  3. Regardless of what is selected, the user can set up a Display Name and a Logo for that given role
  4. If SAML IdP is selected, there is a checklist of supported entity categories
    1. Research & Scholarship
    2. Anonymous Access (v2)
    3. Pseudonymous Access (v2)
    4. Personalized Access (v2)
  5. If SAML SP is selected
    1. Research and Scholarship
    2. Code of Conduct
  • Adding remote entity metadata

Context: the user adds metadata of the entities this deployment should know and trust.

  1. On the metadata management screen the user presses "add remote entity metadata"
  2. The options are conditional on the roles.
    1. If the instance has SAML IDP role, there is an option to add a SAML SP metadata XML (or URL to download)
    2. If the instance has OIDC OP role, there is an option to add a redirect URI, name and description (the instance provisions the client ID and client Secret)
    3. If the instance has SAML SP role, there is an option to add SAML IDP metadata
    4. If the instance has an OIDC RP role, there is an option to add an OP

Deactivate/activate remote entity

  1. On the metadata screen, the entities already added to the instance should be able to be deactivated and reactivate (i.e. a button or check box).

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

  1. Navigation

    1. Top Navigation Bar: Includes links to main sections like Dashboard, Metadata Management, Relation Management, and My Metadata.
    2. Sidebar Navigation: For quick access to subsections within the main areas.

  2. Forms and Input Fields

    1. Text Input Fields: For entering metadata, display names, and other textual information.
    2. Dropdown Menus: For selecting options such as entity categories, SPs, and IdPs.
    3. Checkboxes and Radio Buttons: For selecting multiple or single options, such as supported entity categories and requested attributes.
    4. File Upload Fields: For importing metadata files or uploading logos.
    5. Toggle Switches: For activating or deactivating SPs/IdPs.

  3. Buttons and Actions

    1. Primary Action Buttons: For saving, adding, or submitting forms.
    2. Secondary Action Buttons: For canceling, editing, or deleting actions.
    3. Icon Buttons: For quick actions like editing or deleting items in a list.

  4. Tables and Lists

    1. Data Tables: For displaying lists of SPs/IdPs, including columns for relevant metadata and actions.
    2. Paginated Lists: For managing large datasets with navigation controls.
    3. Expandable Rows: For viewing detailed information about a specific SP/IdP within a table.

  5. Modals and Dialogs

    1. Confirmation Dialogs: For confirming actions like deletions or important changes.
    2. Form Modals: For adding or editing metadata in a focused environment.

  6. Search and Filter

    1. Search Bars: For finding specific SPs/IdPs or metadata entries.
    2. Filter Options: For narrowing down lists based on criteria like entity categories or active status.

  7. Feedback and Notifications

    1. Toast Notifications: For temporary messages about actions (e.g., "Metadata saved successfully").
    2. Error Messages: Inline or modal messages for form validation errors or system issues.
    3. Success Messages: Inline or modal messages confirming successful actions.

  8. Dashboard Widgets

    1. Summary Cards: For displaying key metrics and statuses (e.g., total SPs, active IdPs).
    2. Activity Feeds: For showing recent actions and changes.

  9. Visual Indicators

    1. Status Badges: For indicating the status of SPs/IdPs (e.g., active, inactive).
    2. Progress Bars: For showing the progress of actions like file uploads or metadata synchronization.

  10. User Profile and Settings

    1. Profile Dropdown: For user account management, logout, and settings.
    2. Settings Page: For configuring user preferences and system settings.


 Wireframes



  • No labels