User Interface Elements in IdP Metadata
This page describes how an IdP site administrator adds user interface elements to metadata. These elements are used by SP implementations to enhance their user interfaces. See the section on software support for a complete list of supported applications.
Updating your Metadata
Login to the metadata administrative interface as usual. Along the left hand side, click on the link "Identity Provider Metadata Wizard," click "Edit," and then click "Add New User Interface Elements". A web form to enter the new elements will appear.
When you press "Save," an <mdui:UIInfo> extension element is inserted into your metadata. From that point forward, you manage these elements the same as you would any other metadata element.
User Interface Elements
All of the input fields below except Display Name are optional for IdPs.
Display Name
The value of this input field inherits from the existing <md:OrganizationDisplayName> element in IdP metadata. Since the Federation is authoritative for the latter, the former is non-editable by the user.
Typically, the value of the Display Name field will appear on the drop-down menu of discovery service interfaces. If the corresponding element does not exist in metadata, applications are required to fall back on the <md:OrganizationDisplayName> element. Since the two are necessarily the same in InCommon metadata, the same name will appear in the discovery interface in either case.
This element is required in InCommon metadata.
Description
A brief description (100 characters or less) of the IdP service may be provided. On systems that support a pointing device (such as a mouse), the content of this input field will pop up when the user hovers over the Display Name.
This element is optional in InCommon metadata but IdP operators are encouraged to supply it.
Information URL
A link to a more comprehensive information page may be provided. This page should expand on the content of the Description field.
This element is optional. There are no known applications that can leverage this element in metadata.
Privacy Statement URL
A link to the IdP's Privacy Policy may be provided.
This element is optional. There are no known applications that can leverage this element in metadata.
Logo URL
This element is optional but there are applications that can leverage this element in metadata so IdP operators are encouraged to provide a link to a logo that meets the following requirements. For example, a discovery service may use a visual cue (i.e., a logo) instead of or in addition to the Display Name.
The logo must be specified using an HTTPS URL. The host in the URL must reside in a domain owned by the IdP. These are the only strict requirements of a logo URL in metadata.
The actual size of the logo may vary. You will be asked to enter the actual width and height of the logo (in pixels). The application will select your logo (or not) based on the actual width and height entered into metadata.
Generally useful logos are thought to have the following characteristics:
- the logo should have a transparent background
- the logo should have a landscape orientation (width > height)
- an aspect ratio between 4:3 and 16:9 is considered optimal
- the logo should have a minimum width of 100 pixels
- the logo should have a minimum height of 75 pixels
Logos that meet the minimum width and height requirements can be scaled down by the application as needed.
Software Support
To our knowledge, the only application that supports the <mdui:UIInfo> extension element in IdP metadata is the Shibboleth Embedded Discovery Service. If you know of other software applications that support <mdui:UIInfo>, please share this information with the community.