Creating an ID vault server IdP configuration document

This configuration document is used for both Notes federated login and Web federated login.

Before you begin

Have the metadata .xml file that you exported from your IdP, for example FederationMetadata.xml, in a location from which you can access it so that you can import it into the IdP configuration document.


  1. Open idpcat.nsf on the ID vault server.
  2. Click Add IdP Config to create a new configuration document.
  3. In the IdP name field, enter a name to identify the Web site of the identity provider; the name does not have to be exact, and is only for your administrative convenience.
    For example, if the Renovations organization has a support site hosted by a third party who will serve as an identity provider, using the IBM® Tivoli® Federated Identity Manager, the administrator might enter Renovations Customer Support (TFIM).
  4. In the Protocol version field, select a SAML version.
    Important: SAML 2.0 is required if your federation is configured on ADFS.
  5. In the Federation product field, select either TFIM for Tivoli® Federated Identity Manager or ADFS for Active Directory Federation Services, depending on which federation service you intend to use for SAML authentication.
  6. If you selected SAML 2.0, click Import XML file and select the metadata .xml file you imported from your IdP. In ADFS, this file name is typically FederationMetadata.xml.
    The following information is imported from the .xml file; do not modify it.
    Table 1. Fields in the IdP Configuration document whose values are generated from the metadata .xml file
    Field Description
    Artifact resolution service URL Domino® generates the artifact URL for the federation service you specified in the Product field.

    For example, for the Renovations organization, using TFIM, SAML 2.0, and SSL, the following artifact URL might be generated:

    Single sign-on service URL If the data is available in the imported XML file, Domino® generates the login URL for the federation service you specified in the Product field.

    For example, for the Renovations organization, using TFIM, SAML 2.0, and SSL, the following login URL might be generated:

    Note: The value in this field is a subset of the expected URL to the IdP. The Domino® server generates the full URL when necessary.
    Signing X.509 certificate Domino® imports the certificate code from file.
    Encryption X.509 certificate

    Domino® imports the certificate code from file.

    Note: This field appears only when the Type field is set to SAML 2.0.
    Protocol support enumeration Domino® generates a string designating the protocol(s) for the SAML release specified in the Type field that are also supported by the specified IdP. This string will become part of authentication URLs provided by Domino® as the service provider to the IdP specified in this configuration document.

    For example,

  7. On the Basics tab, in the Host names or addresses mapped to this site field, enter the DNS host name of the ID vault server, preceded with the string vault. For example:
  8. Leave State for this Configuration document as Enabled (the default).
  9. In the Service provider ID field, enter a value to identify the ID vault server as service provider partner with the IdP.
    For example:
    • This value has to be a properly constructed but it isn't used for HTTP connections.
    • If you are using SSL (required for ADFS), specify https: in the URL.
    • This value must match the value in the IdP trust or partnership that you will create to identify the ID vault server. For example, in ADFS, this value must match the value specified in the Relying party trust identifiers box in the Relying Party Trust.
  10. On the Client Settings tab, complete the following steps, which are related to Notes federated login:
    1. In Enable Windows single sign-on set to Yes if you are using Integrated Windows Authentication (IWA) with ADFS. This field is required by Notes federated login so that Domino® knows how to set up the Notes® client embedded browser.
    2. In the Sites that are trusted field, list trusted identity provider (IdP) web host names that differ from the host name configured in the Basics tab. Separate entries with a semicolon or a return character.
    3. Leave the Enforce SSL field set to Yes if the Notes® client embedded browser requires that any URL accessed at the IdP during the login sequence be protected with SSL.
  11. Save and close the IdP Configuration document.
  12. Optional: If you want to ensure that SAML assertions are encrypted to protect sensitive data, complete the task Generating a certificate to encrypt SAML assertions. Complete it before you complete the task Exporting the ID vault server configuration to idp .xml, so that the certificate is included in the idp.xml file.