Help Center

Menu

Portal authentication

The Portal Authentication system enables users to log into a Squiz digital portal using existing credentials like student IDs or email addresses.

It can be configured to use any attributes captured by existing identity provider (IDP) configurations to streamline the authentication process.

The exact attributes to enter into some of the following fields will differ depending on your IdP provider. They can be extracted from your provider’s SAML response.

Before you start

Satisfy these prerequisites before attempting this procedure:

  • Check that you have Owner primary role or Admin primary role permissions on your Squiz DXP account.

  • Check that your selected portal domain has been configured for portal authentication by Squiz Support. If it has not been configured, it will not appear in the Portal Authentication page and you will not be able to map IdP metadata.

  • Understand that the attributes to enter into fields prescribed in this procedure will differ depending on your IdP vendor. Review your vendor’s SAML metadata prior to completing this procedure to identify the user attributes you want to map.

Steps

To set up portal authentication for a site:

  1. Navigate to Administration  Portal Authentication  DOMAIN

    DOMAIN is the website domain that hosts the portal for which IdP is being configured.

  2. Click the edit (Edit settings) icon to the far right of the row for the chosen domain.

  3. In the Edit settings dialog box, configure the general settings as follows:

    The Domain field is not editable. It is prepopulated with the domain chosen in the previous step.
    Metadata document URL field

    Enter your metadata URL into the Metadata document URL field. This field is required.

    User property map section

    Enter the SAML attribute mapped to the Email field in your SAML response.

    This field is required.

  4. In the Custom user attributes section, click add_circle_outline Add to begin mapping custom attributes found in your IdP metadata document.

    User attribute name field

    Specify a recognizable name for the custom attribute.

    This name does not need to match the attribute’s name as it appears in the SAML response.

    IdP SAML attribute field

    Supply the SAML attribute you want to map to the User attribute name field.

    Locate and include the actual attribute name from the SAML response. Do not assume that this field matches the User attribute name you chose.

  5. Repeat the previous step to add as many custom fields as you need to satisfy your authentication requirements.

    You can configure any fields you require and name them as you wish. However, the attribute supplied must match that found in the SAML response otherwise the mapping will not work.

  6. Click the Save changes button to complete the mapping process.