The Incommon Federation wiki has moved.

Please visit the new InCommon Federation Library wiki for updated content. Remember to update your bookmarks.

Click in the link above if you are not automatically redirected in 15 seconds.



You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

SP User Interface Elements and Requested Attributes

This page describes how an SP site administrator would add user interface elements and requested attributes to metadata.

In a nutshell, here's what you need to do:

  1. Port the attribute requirements listed in your POP to metadata
  2. Refactor the remaining sections of your POP into a Privacy Policy targeted at the user

Complete the above steps in reverse order. First publish your Privacy Policy to a permanent location on the web. Then complete the metadata update process outlined below.

The Relation Between your POP and the Privacy Policy

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 Policy—and everything else mentioned below—refers to a single SP deployment. Hence, you should repeat the steps below for each SP under your control.

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

For the time being, leave your POP where it is despite the fact that it can now be put entirely online. InCommon is reviewing the POP in light of these (and other) developments within the Federation.

Updating your metadata

Login to the metadata management interface as usual. Along the left hand side, click on the link "Service Provider Metadata Wizard," click "View, Edit, or Delete SP metadata," click "Edit," and then click "Add New User Interface Elements and Requested Attributes". A web form to enter the new elements will appear.

User Interface Elements

All of the input fields below except Display Name and Requested Attributes are optional for SPs.

Display Name

Typically, the value of the Display Name field will appear on login and error pages at the IdP, and also on the consent page. If the element does not exist in metadata, applications are required to 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 run multiple services so the organization name is a poor choice to use on a user interface.

This element is required in InCommon metadata.

Description

A brief description (100 characters or less) of the 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 SP operators are encouraged to supply this information.

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 in InCommon metadata but SP operators are encouraged to supply this information.

Privacy Statement URL

A link to the SP's Privacy Policy may be provided.

This element is optional in InCommon metadata but SP operators are strongly encouraged to supply this information.

Logo URL

A user interface may use a visual cue (i.e., a logo) instead of or in addition to the Display Name. Usable logos have the following characteristics:

  • the logo must be specified using an HTTPS URL
  • the logo should have a transparent background
  • the logo size should exhibit a 4:3 aspect ratio

The provided logo will be scaled to 80 pixels wide by 60 pixels high, so any logo with an approximate 4:3 aspect ratio should be fine.

This element is optional but SP operators are encouraged to provide a link to a logo that meets the above requirements.

Requested Attributes

TBD

#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))
  • No labels