User Interface Elements in IdP Metadata
This page describes how an InCommon site administrator adds user interface elements to IdP metadata. These elements are used by SP implementations to enhance their user interfaces, especially the discovery interface.
...
| Table of Contents | ||
|---|---|---|
|
Updating IdP Metadata
Log into the Federation Manager 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 (see screen shot to the right). When you press "Save," an <mdui:UIInfo> extension element will be inserted into your metadata. From that point onward, the user interface elements for your IdP may be managed by clicking "Edit" in the "Identity Provider Metadata Wizard."
User Interface Elements
All of the input fields below except Display Name are optional for IdPs.
IdP Display Name
Typically, the IdP Display Name field will be presented on IdP discovery service interfaces. In practice, if the <mdui:DisplayName> element does not exist in metadata, applications usually fall back on the <md:OrganizationDisplayName> element. The latter is a poor substitute for the IdP Display Name, however, since it assumes an organization deploys at most one IdP.
...
Since the Site Administrator can edit the IdP Display Name field, the ultimate responsibility for disambiguating duplicate or similar IdP Display Names rests with the Site Administrator (not the InCommon RA). To assist with this effort, we provide a current list of IdP display names in InCommon metadata as they will appear on a typical discovery interface (by that we mean a discovery interface that falls back on the <md:OrganizationDisplayName> element if the <mdui:DisplayName> element does not exist in metadata).
IdP Description
The IdP Description is a brief description of the IdP service. On a well-designed discovery interface, the IdP Description will be presented to the user in addition to the IdP Display Name, and so the IdP Description helps disambiguate duplicate or similar IdP Display Names.
The <mdui:Description> element is OPTIONAL in InCommon metadata but IdP operators are encouraged to supply it. It is RECOMMENDED that the value of the <mdui:Description> element be 140 characters or less.
IdP Information URL
The IdP Information URL is a link to a comprehensive information page about the IdP. This page should expand on the content of the IdP Description field.
The <mdui:InformationURL> element is OPTIONAL.
IdP Privacy Statement URL
The IdP Privacy Statement URL is a link to the IdP's Privacy Statement. The content of the Privacy Statement should be targeted at end users.
The <mdui:PrivacyStatementURL> element is OPTIONAL. It is recommended that IdPs use this URL to point directly (or indirectly through another document) to the IdP's Attribute Release Process.
| Anchor | ||||
|---|---|---|---|---|
|
IdP Logo URL
The IdP Logo URL in metadata points to an image file on a remote server. A discovery service, for example, may rely on a visual cue (i.e., a logo) instead of or in addition to the IdP Display Name.
...
There is no consensus as to what constitutes an optimal aspect ratio. For some applications, an aspect ratio between 4:3 and 16:9 is considered optimal. Other applications will have a page layout such that an approximate 2.5 aspect ratio is optimal. A future version of the administrative interface will accept multiple logo URLs so that sites may present a variety of logos to applications.
| Anchor | ||||
|---|---|---|---|---|
|
Software Support
The InCommon Federation entity information pages display the values of all user interface elements in metadata. The information pages are refreshed daily, in parallel with InCommon metadata.
...