Skip to main content

SAML with PortalGuard

This is a Supplementry Guide

This supplements the Configuring your IdP server portion of the Configuring SAML 2.0 docs using PortalGuard as your identity provider (IdP). Please ensure you've already read and understand the concepts in the Configuring SAML 2.0 documentation before continuing.

PortalGuard has support for SAML 2 integrations. Integrating PortalGuard with IE's applications requires configuration in PortalGuard and also in the specific IE application that is being used. If more than one IE application is being used, then the integration needs to be completed for each application.

Configure the SAML IdP

PortalGuard will be acting as the SAML identity provider (IdP). To configure a PortalGuard Relying Party Trust, some information from the IE application is needed.

Create the Relying Party Trust

To complete the IdP configuration in PortalGuard, we need to create a Relying Party with the following settings:

  1. On the General tab:

    • Name: Enter a desired name. This is a free form field, but it is recommended to enter the Innovative Educator's application name.
    • Identifiers: Copy and paste the value of the entityId from the SP metadata file provided by IE.
    • Binding: POST.
    • Assertion Consumer URL: From the SP metadata file provided by IE, find the element: <AssertionConsumerService binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" location="..." and copy the value of the location attribute to here.
    • State: checked
  2. On the Response tab:

    • Default RelayState: (blank)
    • SAML Version: 2.0
    • Digest Algorithm: SHA-1
    • Signing Algorithm: SHA-1
    • Sign SAML Response: unchecked
    • Sign SAML Assertion: checked
    • Override Token Timeout: unchecked
    • NotBefore Clock Skew: 0
    • Override IdP Issuer: (blank)
    • Override Cannonicalization: (blank)

PortalGuard now knows about the Innovative Educator's application.

Releasing user attributes

We need to instruct PortalGuard to send some information about the user to the SP:

  1. In the Relying Party window, select the Identity Claims tab.
  2. Select the appropriate Attribute Store.
  3. For each of the attributes, click Create and then populate the settings:
Important

Please refer to the SAML 2.0 documentation for requirements and recommendations regarding NameID and attributes and claims.

AttributeSend As NameID?Schema TypeValue TypeDirect Field -> Field NameDirect Field -> Value IndexRequired
NameIdchecked(blank)String Field(uid, sAMAaccountName or other identifying attribute)0Required
licenseIdsuncheckedlicenseIdsFormatted StringlicenseIds0Required*
firstnameuncheckedfirstnameString FieldgivenName0Recommended
lastnameuncheckedlastnameString Fieldsn0Recommended
emailuncheckedemailString Fieldemail0Recommended
ref1uncheckedref1String Fieldref10Optional
ref2uncheckedref2String Fieldref20Optional
ref3uncheckedref3String Fieldref30Optional
  1. Lastly click Save. PortalGuard is now ready to authenticate users to the IE application.

Example - One Version of PortalGuard

The populated NameID attribute definition

The populated LicenseIds attribute

The IdP-Initiated tab

The Response tab

Example - Another Version of PortalGuard