Metadata UI and RPI
Instructions on Metadata UI and RPI extensions
Metadata elements for UI
| Element | RFC2119 | Further instructions |
|---|---|---|
| <mdui:DisplayName> | OPTIONAL | A short descriptive name, if possible without abbrevations. It SHOULD say something to the users that are not part of the institution, and as well as be recognised easily by the users associated with the institution. For IdP entities, <mdui:DisplayName> is proposed to have precedence over <md:OrganizationDisplayName> element. |
| <mdui:Description> | OPTIONAL | It is RECOMMENDED that the length of the description is not longer than 140 characters. See examples below. |
| <mdui:Keywords> | OPTIONAL | Keywords are mostly used for searching. Provide only keywords that dinstinguish this institution from the others, most important keywords in the beginning of the list. For example, never provide keywords like university, school, etc. Nor is it neccessary to repeat the same text as in <mdui:DisplayName> element. Good candidates for keywords are abbreviations, faculty names, locations (geographic), etc |
| <mdui:Logo> | OPTIONAL | See the recommendations below. |
| <mdui:InformationURL> | OPTIONAL | The content found at the URL SHOULD provide more complete information than what would be provided by the <mdui:Description> element. The content MUST be publicly available. |
| <mdui:PrivacyStatementURL> | OPTIONAL | A link to the SP's Privacy Policy, as described in Kalmar Memorandum of Understanding and Charter. The content MUST be publicly available. |
Examples on the Description element
- The purporse for SAS-download is to give access to SAS®-software for qualified users. Users will receive license keys by email.
- The purporse for bibliotek.dk is to give access to all public Danish libraries in order to search for and order materials
Recommendations on the Logo element
- Logos SHOULD be as square as possible (1:1).
- Logos SHOULD be at least 300×300 px.
- Logos SHOULD look nice when resized to 50×50 px. This means, do not use to much details. Text much be large when the resolution is high.
- Logos SHOULD be in PNG format with transparent background.
- Logos SHOULD look good on white background.
- Logos SHOULD NOT look bad on 20% grey.
- Logos SHOULD fill approx 50% of the image with color. Heavy icons should be made lighter, and lighter logos made heavier. This is to have balance between logos when shown on a list.
Metadata elements for IdP Discovery
| Element | RFC2119 | Further instructions |
|---|---|---|
| <mdui:IPHint> | OPTIONAL | May have several IPv4 or IPv6 address blocks |
| <mdui:DomainHint> | OPTIONAL | May have several domain names |
| <mdui:GeolocationHint> | OPTIONAL | May have several campus locations |
Metadata elements for Registration and Publication info
| Element | RFC2119 | Further instructions |
|---|---|---|
| <mdrpi:RegistrationInfo> | MUST | Added by National federation |
| <mdrpi:PublicationInfo> | MUST | Added by Kalmar aggregate |
| <mdrpi:PublicationPath> | MUST NOT |
For elements' attributes and their necessity, see the Metadata RPI specification.
Principles regarding the elements
The element values must be of high quality
If the lang attribute(s) is present, at least lang=”en” must be in place.
References
SAML V2.0 Metadata Extensions for Login and Discovery User Interface, CS Draft 02, 26 July 2011, http://wiki.oasis-open.org/security/SAML2MetadataUI
SAML V2.0 Metadata Extensions for Registration and Publication Information, Working Draft 07, 23 June 2011, http://wiki.oasis-open.org/security/SAML2MetadataDRI
