Versions Compared

Old Version 7

changes.mady.by.user Héder Mihály

Saved on

compared with

New Version Current

changes.mady.by.user Branko Marovic

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Use cases

Initial setup after installation

Context: The instance may participate in at least one, potentially multiple federations (federation being one or more federations. "Federation" is a generic term here, either meaning encompassing SAML federations as well as , a bunch collection of OIDC parties, as well as or an intra-organization organisation set of entities (internal federation). Therefore it The instance will have an identity as either a service provider (SAML SP or OIDC RP) or , an identity provider (SAML IdP or OIDC OP), or both. This or these will be the deployment's role(s)These roles will define the deployment’s identity.

  1. After the deployment, the "My Metadata" screen is initially empty.
  2. With an "Add Role" (we might rename it if there is a better suggestion) button, the user selects can select one of the following: SAML IdP, OIDC OP, SAML SP, OIDC RP.
  3. Regardless of what is selectedthe selection, the user can set up a Display Name and a Logo for that given the chosen role.
  4. If the SAML IdP role is selected, there is a checklist of supported entity categories will be available:
    1. Research & Scholarship
    2. Anonymous Access (v2)
    3. Pseudonymous Access (v2)
    4. Personalized Personalised Access (v2)
  5. If the SAML SP role is selected, the following settings/attributes are available:
    1. Research and & Scholarship
    2. Code of Conduct

Adding remote entity metadata

Context: the The user adds can add metadata of for the entities this deployment should know and trust.

  1. On the metadata management screen, the user presses "add Add remote entity metadata."
  2. The available options are conditional depend on the roles .configured:
    1. If the instance has the SAML IDP IdP role, there is an option to add a the user can add SAML SP metadata from XML ( or a URL to download).
    2. If the instance has the OIDC OP role, there is an option to the user can add a redirect URI, name, and description (the instance provisions the client ID and client Secretsecret).
    3. If the instance has the SAML SP role, there is an option to the user can add SAML IDP IdP metadata.
    4. If the instance has an the OIDC RP role, there is an option to add an OPthe 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

  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).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.'
In this case, you can add identity and profile attribute mappings.

Edit data sources and data release (not MVP)

Context: This applies only applies if there is a SAML IdP or OIDC OP role is enabled.

ContextNote: for For the MVP we don't do , custom attribute release per remote entity . There is one is not implemented. Instead, there is a generic setup that may still be still conditional on remote entity categories (ie.eg., CoCo gets more {attributes?}).

  1. On the Configuration screen, the user adds a data source:
    1. SQL
    2. LDAP(other? - non MVP)
    3. Other...
  2. The user adds connection data for the data source.
  3. The user adds attribute mappings for the data sourcei, e.eg., DB field → attribute name.

Information architecture

  • Dashboard

    • Overview of metadata management status.
    • Quick access to recent activities and common tasks.
  • Configuration
    • Config Configuration of the local instance that is not related to remotesunrelated to remote entities.
      • Attribute sources

  • 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

  1. Navigation

    1. Top Navigation Bar: Includes links 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 cancelingcancelling, 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 synchronizationsynchronisation.

  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.

...