Versions Compared

Key

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

User Interface Elements in SP Metadata

This page describes how an SP metadata administrator adds user interface elements to metadata. These elements are used by IdP implementations to enhance their user interfaces. See the section on software support for a complete list of supported applications.

...

Table of Contents
minLevel3

Updating SP Metadata

Login to the metadata administrative interface as usual. Along the left hand side, click on the link "Service Provider Metadata Wizard" and then click on the entity ID of the SP you wish to edit. Now click "View, Edit, or Delete SP metadata," click "Edit," and finally click "Add New User Interface Elements and Requested Attributes". 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 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 SPs.

Anchor
DisplayName
DisplayName

SP Display Name

The SP Display Name is a user friendly name for the service (not the organization). Typically, the value of the SP Display Name field will appear on login and error pages at the IdP, and also on the consent page. If the corresponding element <mdui:DisplayName> does not exist in metadata, some applications fall back on the <md:OrganizationDisplayName> element, which typically does not reflect the service but rather the organization that runs the service. Such an organization may in fact run multiple SP services, so the organization name is a poor choice to use on a user interface.

...

Anchor
Description
Description

SP Description

A brief SP Description (140 characters or less) of the service may be provided. On computers that support a pointing device (such as a mouse, e.g.), the description will pop up when the user hovers over the SP Display Name.

...

Anchor
InformationURL
InformationURL

SP Information URL

The SP Information URL is used to create a link to a service information page. The content of this page should expand on the content of the SP Description field. The Information URL is often presented to the user on the IdP's login page or perhaps the consent page.

...

Anchor
PrivacyStatementURL
PrivacyStatementURL

SP Privacy Statement URL

The SP Privacy Statement URL is used to create a link to a Privacy Statement targeted at end users. Like the Information URL, the Privacy Statement URL is often presented to the user on the IdP's login page or consent page.

...

Note
titleThe Relation Between your POP and the Privacy Statement

Since you only have one POP, it necessarily applies to all of your SP deployments. In that sense, the granularity of the POP is not sufficient for those sites supporting multiple SPs. On the other hand, your Privacy Statement refers to a single SP deployment.

Note: A Privacy Statement may be shared across multiple SP deployments. Not all SPs have the same privacy requirements, however, so you should carefully consider the granularity that best fits your overall SP deployment.

Anchor
logo
logo

SP Logo URL

The SP Logo URL is a service logo for building graphical user interfaces.

...

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 provide a variety of logos.

Anchor
software
software

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.

...