Parent topic: SAML
Additional Faspex Configuration Options / SAML

Setting Up Custom SAML Fields

Aspera Faspex can import customer-specified SAML fields and import them as User Profile fields. The following instructions describe how to set up custom SAML fields in Faspex:

  1. Add desired fields to your directory service.
  2. Add new SAML fields to your SAML identity provider (IdP). These fields must be correctly mapped to your directory service.
  3. Add and configure Faspex custom fields in Server > User Profile.

    The following section describes configuration options for a SAML custom field:

    Configuration Option Description
    Enabled Check this box to enable or disable the custom field. This will enable or disable both the Name and SAML Name fields. (Fields are enabled by default.)
    Name Enter the desired name of your custom field into the text box. This field applies to Local users.
    SAML Name Enter the name of the SAML field found in your IdP.
    Note: The SAML Name field column applies to SAML users and will only appear when SAML is enabled in Faspex.
    Important: The Faspex SAML Name must be correctly mapped to your SAML fields in IdP. If the names are incorrectly mapped, Faspex will reject the user login. For more information on custom SAML fields, refer to Setting Up Custom SAML Fields.
    Required Require new users to fill out the field. Unchecking the box makes the field optional. (Fields are required by default.)
    Note: SAML user login will fail when the field is required but the SAML response doesn't include the required custom attributes (when names are incorrectly mapped).
    Click the button to select a field for deletion. Then click Cancel to cancel deletion or Save Fields to delete.
    Note: Deleting a field will permanently delete the custom field and all its data from all existing users.
  4. Accept your changes by clicking Save Fields.
  5. Follow your SAML login procedure and the new fields should get imported.
To view your custom fields, go to the Accounts tab. Click the Toggle Columns drop-down and check the box of the field you want displayed. You can also sort and filter users by custom fields. See Sort or Filter accounts for more information on sorting and filtering users.
Parent topic: SAML