User Interface Elements in Metadata

Federation metadata supports elements that contribute to rich, dynamic user interfaces (UIs). These elements include:

• Display Name
• Description
• Information URL
• Privacy Statement URL
• Logo URL

The IdP administrator adds UI elements to metadata for the discovery and error pages at the SP. The SP administrator adds UI elements to metadata for the login, consent, and error pages at the IdP. As a result, the overall user experience is enhanced.

Technical Details

The SAML V2.0 Metadata Extensions for Login and Discovery specification defines an <mdui:UIInfo> extension element. InCommon supports the following child elements of the <mdui:UIInfo> element:

• <mdui:DisplayName>
• <mdui:Description>
• <mdui:InformationURL>
• <mdui:PrivacyStatementURL>
• <mdui:Logo>

An example follows:

<!-- User Interface Elements for InCommon IdPs and SPs -->
<md:Extensions>
  <mdui:UIInfo
      xmlns:mdui="urn:oasis:names:tc:SAML:metadata:ui">
    <mdui:DisplayName xml:lang="en">...</mdui:DisplayName>
    <mdui:Description xml:lang="en">...</mdui:Description>
    <mdui:InformationURL xml:lang="en">...</mdui:InformationURL>
    <mdui:PrivacyStatementURL xml:lang="en">...</mdui:PrivacyStatementURL>
    <!-- the logo will be scaled to the given width and height -->
    <mdui:Logo width="80" height="60">...</mdui:Logo>
  </mdui:UIInfo>
</md:Extensions>