Live Forms v7.4 is no longer supported. Please visit Live Forms Latest for our current Cloud Release. Earlier documentation is available too.
Azure SAML Security Manager
supports the creation of a tenant using the Azure SAML (Security Assertion Markup Language) Security Manager. Users in this tenant are redirected to the Microsoft Azure login screen and then to when that login screen is submitted.
The Azure SAML Security manager can be used in cloud and on-premise installations.
- Allows on-premises AD to be exposed to the frevvo cloud via synchronization with Azure AD
- Uses the graph API to access users and groups from AD.
- SAML is used for authentication only, providing single sign on.
- SAML is built into Azure AD. It is not necessary to setup an identity provider.
The Azure SAML Security Manager pulls users/roles from Azure AD. frevvo recommends using the SAML Security Manager for customers who want to manage users/roles from the UI.
On this page:
Prerequisites
- You will need a valid Microsoft Azure subscription
The frevvo.TenantAdmin and frevvo.Designer groups must be specified on your Active Directory server. The group names must be spelled as shown. Upper/lower case may be a factor for Open LDAP systems. These groups are required.
- Tenant admin users must be assigned to the frevvo.TenantAdmin group.
- Designer users must be assigned to the frevvo.Designer group.
- The frevvo.Publisher and the frevvo.ReadOnly groups are optional. Refer to the links provided for information about when these groups are used to help you decide whether or not you want to create them.
- Users with the frevvo.publishers role must be assigned to the frevvo.Publisher group. Refer to the Administrator Best Practices for an explanation of this role.
- Users with the frevvo.ReadOnly role must be assigned to frevvo.ReadOnly group.
- Users with the frevvo.publishers role must be assigned to the frevvo.Publisher group. Refer to the Administrator Best Practices for an explanation of this role.
- The group names for these three special roles must be frevvo.TenantAdmin, and frevvo.Designer. Upper/lower case may be a factor for Open LDAP systems.
- frevvo Best Practice recommends that you create a user account in your Active Directory or IDP that will house all of your deployed Production forms/flows. This user can be named anything i.e.frevvoProduction but it must be a member of the frevvo.Designer group
- If you want to preserve Applications/Forms/flows developed in your trial/starter tenant, download them to your desktop as a backup BEFORE changing the Security Manager
- frevvo only supports the Azure SAML Security Manager when is running in the tomcat container. Refer to our Supported Platforms for the list of Application Servers supported/certified by frevvo.
Configuring the Azure SAML Security Manager
Follow these steps listed below to create a tenant using the Azure SAML Security Manager:
- Create an Application for Live Forms in Azure
- Create the Live Forms metadata file
- Create the Azure Tenant Idp metadata file
- Create/edit the Azure SAML tenant
- Log into your Live Forms Azure SAML tenant
Step 1 - Create an Application for Live Forms in Azure
frevvo assumes that customers have someone on staff that can successfully perform this step of the procedure. Information about is listed below to help you with this process.
The Azure global administrator MUST create the application for in Azure.
If you are familiar with the Microsoft Azure Legacy Portal, review this Microsoft Training Guide before setting up the Azure application for .
Step 2 - Create the Live Forms metadata file
Follow these steps to generate the frevvo metadata for your Azure SAML tenant. You can do this even if the tenant has not been created yet.
Paste this URL into your browsr:
Cloud Customers: https://app.frevvo.com:443/frevvo/web/saml/metadata/alias/{t} - replace {t} with the name of your tenant - Ex; azuread
On-premise customers: http://<server>:<port>/frevvo/web/saml/metadata/alias/{t} - replace <server> with the ip of your server, <port> with the port number (if applicable) and t with the name of your frevvo tenant.
When the metadata displays, save the page as an xml file.
- We will need to copy the entire metadata from this file to the Azure SAML Security Manager configuration screen.
- Metadata must be generated for each Azure SAML tenant. Each tenant will have a unique URL.
Step 3 - Create the Azure Tenant Idp metadata file
Follow these steps:
Browse the Federation Metadata Document URL that you copied to your notepad when creating the Azure application for . It is located on the Endpoints tab in your frevvo Azure application.
Example of Federation Metadata Document URL from Endpointshttps://login.microsoftonline.com/fece6b7e-fbc6-4b3a-8287-fc07c29aa2d2/FederationMetadata/2007-06/FederationMetadata.xml
Save all the metadata returned as an xml file. We will need to copy the entire metadata from this file to the Azure SAML Security Manager configuration screen.
Step 4 - Create/edit the Azure SAML tenant
To successfully create a tenant using the Azure SAML Security manager, you will need the following:
- metadata file
- The Azure SAML tenant Idp metadata file
- Attribute mapping information
- The Azure tenant ID, the client id and client secret key that are created as part of registering the frevvo application.
cloud customers, migrating your tenant to the Azure SAML Security Manager, will make the changes via the Edit Tenant screen. Once accessed, follow these steps beginning with step 3.
- Log onto as the superuser (on-premise) or the tenant admin (cloud).
- Access the Add Tenant (on-premise) or Edit Tenant (cloud) screen.
- Select Azure SAML Security Manager from the Security Manager Class dropdown.
- Copy the Service Provider (frevvo) metadata into the Service Provider field. You can include the xml prolog when you paste the Service Provider (frevvo) metadata.
- Copy the metadata from the Azure tenant IDP file previously created and paste it into the Identity Provider field.
Enter the Federation Metadata Document URL that you copied from Endpoints in your frevvo Azure application. The URL is needed to handle Signing key rollover in Azure Active Directory. This URL is polled and refreshes the Azure IDP metadata every 3 hours. The new metadata is stored and automatically used as backup in case the URL is not accessible.
Example of Federation Metadata Document URLhttps://login.microsoftonline.com/fece6b7e-fbc6-4b3a-8287-fc07c29aa2d2/FederationMetadata/2007-06/FederationMetadata.xml
Check the Ignore Case checkbox if you are using LDAP for authentication and you want to ignore the case stored in LDAP systems for users/roles. The field is checked by default. Refer to the Mixed or Upper case User Names topic for more information.
Enter the User Id. This should be the User property name that identifies the user. A typical value is userPrincipalName, givenname etc.
- Custom attributes can be mapped by typing the attribute names in the Custom field separated by a comma.
- Enter the following information in the API Access section.
- Enter the Azure tenant identifier into the tenant Id field. This can be obtained by viewing the endpoint Urls listed when you click View Endpoints in your frevvo Azure application.
- Enter the client id and client secret key that were created as part of registering the frevvo application into the respective fields.
- Configure a tenant admin account. This account does not require Azure SAML authentication. This tenant admin can log directly into providing a default security manager backdoor.
- The tenant admin id, password and email fields are required.
- When this tenant admin performs a form based login i.e. /frevvo/web/login, the password entered on this screen is used for authentication. This is also the URL used by the API.
- If the tenant based login url is used i.e. /frevvo/web/tn/{t}/login then the Azure SAML login is used.
The forgot password function works for an Azure SAML tenant admin user. For all others, it will display the error message about not being supported for the tenant. - Configure the Business Calendar for your tenant. The escalation feature will use this calendar to calculate deadlines and send notiifcation and reminder emails.
- Enter HTTP Auth credentials if required. Credentials for external secure web services accessed by the forms and flows in your tenant can be specified in this section.
- Click Submit.
Step 5 - Logging into a Live Forms Azure SAML Tenant
- Paste this tenant specific URL into your browser:
Cloud Customers: https://app.frevvo.com:443/frevvo/web/tn/{t}/login - Replace {t} with the name of your Azure SAML tenant.
- On-premise Customers:http://<server>:<port>/frevvo/web/tn/{t}/login. Replace <server> and <port> with your server information and t with the name of your Azure SAML tenant.
The user is redirected to the Azure login screen.
If the user is authenticated, screens display depending on the level of authorization specified for the user. Designer users will see the Application Home Page while non-designer users will be directed to their Task List.
You will see this redirection when logging into a space as well.
- Clicking the logout link in , logs the user out from only.
- When a user logs in to space, the logout link will not be visible in an Azure AD (SSO) tenant.
- When a user logs in to (non-space mode), the logout link will be visible in an Azure AD (SSO) tenant.
Logged in User Display in Azure SAML Live Forms tenant
If your Azure SAML userIds are in the format <username>@<domain name>, when you login to the tenant name is appended to the userId (ex: username@<domain name). This is as designed . You will see <username@domain name@frevvo tenant name> as the logged in user at the top of the screen. If your domain name is the same as your tenant name, it will appear as if the domain name is listed twice.
Azure SAML Tenant backdoor admin user
Just a reminder that the tenant admin account can login directly into Live Forms or use the Azure SAML login.
When you create a new tenant you are prompted to set up a tenant admin user id and password. This tenant admin does not authenticate via your Azure SAML IDP. It only exists in Live Forms. If you experience an issue with your Azure SAML configuration such that you can't login as an Azure SAML authenticated user, this account provides a backdoor you can use to login to your tenant as a tenant admin in order to fix your Azure SAML configuration issue. Only one backdoor tenant admin account is supported.
If your tenant originally used the Default Security Manager and then you changed to the Azure SAML Security Manager, this tenant admin account has already been setup. If you have forgotten the password, you can change it by :
- Using the Live Forms Forgot Password? feature for the tenant admin account.
- Logging in as a Azure SAML authenticated tenant admin and changing the password via Manage Users.
What if you do not remember the userid of your original tenant admin? Follow these steps:
- Login as your authenticated Azure SAML tenant admin
- Click Manage Users and click the edit admin icon.
Session Timeout
Session timeouts are configured in and in your Azure SAML IDP. If a user's session ends before the IDP timeout is reached, they will automatically be logged back into if they try to access it again. It is recommended that the session timeout and the IDP session timeout be configured for the same value.
Embedding Forms/Flows in your website
Embedding forms and flows into your website when using the Azure SAML Security Manager, will work in the following scenarios :
- The visibility of the form is set to Public.
- The visibility of the form is set to Public in Tenant and the user is already authenticated to Azure SAML
Embedding forms and flows into your website is NOT supported if the the visibility of the form is set to Public in Tenant and the user is NOT already authenticated to Azure SAML. This is because frevvo must direct the user to the IDP login screen and the browser will not allow loading the IDP login page in frevvo's form iframe.
Troubleshooting
Logging into a Azure SAML tenant as (user@Azure SAML tenant name)
Logging into a Azure SAML tenant as (user@Azure SAML tenant name) displays an application error message.
On-premise customers using the tomcat bundle will see the following entry in the error log:
Application error processing /frevvo/web/login?null java.lang.UnsupportedOperationException: null
Accessing a Space in a AzureAD tenant on a mobile device will not display a logout button.
Skew error when logging into an Azure tenant
Users logging into a Live Forms Azure SAML tenant may encounter the error "Access Denied. Authorization Required". Examination of the frevvo.log shows the following entry:
Response issue time is either too old or with date in the future, skew 60, time 2016-06-01T05:49:25.330Z
Follow the instructions listed in the Installation Tasks chapter to add the parameter.
Login into the Azure SAML tenant fails
If the login into your Azure SAML tenant fails and the log reports the following error, you may have to edit your Azure SAML tenant to add the metadata URL. T
org.opensaml.xml.validation.ValidationException: Signature is not trusted or invalid.
The URL is needed to handle Signing key rollover in Azure Active Directory. This URL is polled and refreshes the Azure IDP metadata every 3 hours. The new metadata is stored and used as backup in case the URL is not accessible. Refer to Step 6 above for the details.
Retrieving Custom Attributes from Azure Active Directory in an Azure SAML Tenant
The Azure AD Graph API allows access to users, groups etc... in Azure AD. User entity attribute data exposed by the API for the logged in user can be pulled into fields in your form/flow with a business rule. If the attribute that you are looking for is not already exposed, you can:
- Sync Azure AD to your in-house AD via the Microsoft provided connector
- Add an extension property
Once the custom attributes are made available, add them to the Custom section of your Azure SAML tenant.
- Login to your Azure SAML tenant as the as the tenant admin.
- Click the Edit Tenant link
- Add the custom attributes to the Custom section as a comma separated list. The image shows the department and displayName attributes listed in the custom attribute section.
- Design your form/flow with fields to collect the information.
- Write a business rule to populate the controls with the custom attribute information.
Here is an example of a rule that will retrieve the custom attributes, department and displayName, plus the standard attributes, First Name, Last Name and Email address.
if (form.load) { FirstName.value = _data.getParameter('subject.first.name'); LastName.value = _data.getParameter('subject.last.name'); EMail.value = _data.getParameter('subject.email'); department.value = _data.getParameter('subject.department'); displayName.value = _data.getParameter('subject.displayName'); }
Using the SharePoint Connector in an Azure SAML Security Manager tenant
At least one designer user that is going to be connecting forms/flows to SharePoint with the Save to SharePoint wizard must also be a SharePoint user with the correct privileges to provide consent if your tenant is configured with the Azure SAML Security Manager .