Skip to content

Metadata Element

Michael Hallock edited this page Oct 16, 2017 · 1 revision

The <metadata> element allows for configuration of additional information used in metadata file generation.

The <metadata> element exposes the following attributes.

Attribute Use
excludeArtifactEndpoints (Optional) Specifies whether Artifact endpoints should be included in generated metadata files (Some identity providers require these are excluded).
lifetime (Optional) Specifies a timespan to use for checking of metadata lifetime (Default to "7.00:00:00", or seven days).

Contacts

The <contacts> element can contain multiple <contact> elements that provide ContactPerson information for SAML metadata file generation.

Each <contact> exposes the following attributes:

Attribute Use
type Text attribute that specifies information about the contact type. Can be one of the following values: Administrative, Technical, .
givenName Contact's given name.
surName Contact's surname.
company Contact's company.
email Contact's email address.
phone Contact's telephone number.

The format for specifying <contact> elements is given below:

<saml2>
    <metadata>
    <contacts>
        ...
        <contact type="Administrative" company="Company" givenName="John" surName="Doe" email="test@test.com" phone="1234567890" />
        </contact>
    </contacts>
    </metadata>
</saml2>

Organization

The <organization> element allows for configuration of additional information used in metadata file generation. Only one organization can be specified for a given implementation.

The <organization> element exposes the following attributes:

Attribute Use
name Organization's name.
displayName Organization's full name, used for purposes of selection, etc.
url Organization's URL.

The format for specifying the <organization> element is given below:

<saml2>
    <metadata>
    ...
    <organization name="Org" displayName="Full Organization Name" url="http://www.example.com" />
    </metadata>
</saml2>

RequestedAttributes Element

The <requestedAttributes> element specifies the collection of SAML attributes that the Service Provider requires from the Identity Provider. Attributes may be added using the following syntax:

<saml2>
    ...
    <requestedAttributes>
    <add name="urn:cn" />
    </requestedAttributes>
    ...
</saml2>

Attribute elements expose the following attributes:

Attribute Use
name The SAML attribute's identifier. Note that this attribute refers to the name property of a SAML attribute, not the optional friendlyName property that may be found in the identity provider's metadata.
isRequired An optional attribute that specifies whether the SAML attribute should be listed as ‘required’ in the service provider’s metadata.