Page History
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
User discovery:
There is no guarantee that the first login will occur before a task is created for a specific user /role. If you have workflows, that are routed to users who have not logged in yet, your workflow may not do what you expect. If the user’s role changes after 1st login but before the next task is routed to their new role, the task will not appear on their Task List. For example, a user with the role of employee, logs into
. The user then gets promoted to manager. The user will not receive a task routed to the user's new role of manager if the. workflow is initiated before the user logs out and logs in again and the user account is updated.Frevvoproduct Manually creating/uploading users and roles ahead of time avoids this situation.
- Active Directory:
- Customers using LDAP must ensure that the frevvo.User, frevvo.TenantAdmin and frevvo.Designer roles are specified on their LDAP/AD server.
- All users requiring access to
must be assigned to the frevvo.User group.Frevvoproduct - Tenant admin users must be assigned to the frevvo.User and frevvo.TenantAdmin groups,
- Designer users must be assigned to the frevvo.User and frevvo.Designer groups.
- All users requiring access to
- Customers using LDAP must ensure that the frevvo.User, frevvo.TenantAdmin and frevvo.Designer roles are specified on their LDAP/AD server.
...
In the directions given below, the Service Provider refers to frevvo
Frevvoproduct |
---|
Frevvoproduct |
---|
Frevvoproduct |
---|
- In-house Customers Only
- Create the frevvo Metadata file.
- Configure your Identity Provider
- Create/edit the SAML tenant
- Manage Users/Roles for your SAML tenant
- Logging into Live Forms in a SAML Tenant
Section 1 - In-house Customers Only
...
Expand | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
Configure Custom AttributesActive directory attributes other than the standard First Name, Last Name or Email are considered custom attributes. You can retrieve custom attributes in addition to the standard ones from Active Directory and pull the data into your form/flow using Live Forms business rules. Perform these general steps:
|
Expand | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
Follow these steps to setup Google as the Identity Provider and Live Forms as the Service Provider to configure Single Sign On. These instructions are for Cloud. On-Premise customers follow the same steps with one additional step to generate a certificate:
|
...
To successfully create a
tenant using the SAML Security manager, you will need the following: Frevvoproduct
metadata file Frevvoproduct
- The metadata for your Identity Provider
- Attribute mapping information
...
- Access the Add Tenant (on-premise) or Edit Tenant (cloud) screen.
- Select SAML Security Manager from the Security Manager Class dropdown.
- Copy the Service Provider (frevvo) metadata into the Service Provider field. The xml should be pasted without the prolog. For example, the image shows an example of the frevvo metadata file before pasting:
- Retrieve the metadata for your Identity Provider. For example, for the Shiboleth product the metadata is located in the idp-metadata file.
- Paste the metadata into the Identity Provider field. This metadata should also be pasted without the prolog.
- 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. It is checked by default. Refer to the Mixed or Upper case User Names topic for more information.Frevvoproduct Check the Authentication Only checkbox if you want SAML to handle authentication and provide user identification but all other user attributes come from the
database.Frevvoproduct
When checked, the screen display changes as attribute mapping, other than the mapping for the user id and custom attributes, is no longer necessary.Note - If Authentication Only is checked:
- SAML will authenticate the user but not retrieve any of the attributes. Authorization depends on the roles defined in
. Changes made in theFrevvoproduct
UI will not be overridden if the user logs out and then logs in again.Frevvoproduct - Manual creation of users & roles in the
SAML tenant is required. This can be done with a csv upload.Frevvoproduct
- SAML will authenticate the user but not retrieve any of the attributes. Authorization depends on the roles defined in
- If Authentication Only is unchecked:
All users requiring access to
must be assigned to the frevvo.User group in Active Directory. Tenant Admins must be assigned to the frevvo.User and frevvo.TenantAdmin groups. Designer users must be assigned to the frevvo.User and frevvo.Designer groups.Frevvoproduct - Users are added (discovered) when they log in.
- It is important to know that a SAML tenant in this mode (SAML/LDAP handles authentication and authorization) that users and tenant admins can modify user information in the
UI. If user information/role assignment is changed in theFrevvoproduct
UI, the changes will be overwritten by the information in SAML the next time the user logs out and then logs back in again. In this case, make the changes in your Active Directory to make them permanent.Frevvoproduct
- If Authentication Only is checked:
Map the attributes configured in your Identity Provider by entering the name for each attribute in the corresponding field on the
screen. Be sure to provide the attribute name - not the friendly name. For example, if you are using Shibboleth for your Identity Provider the attribute information is located in the attribute-resolver.xml file. The image shows the section of the file where the attributes are defined.Frevvoproduct
The image below shows the attribute mapping on the
screen with the attribute names from the Shibboleth file:Frevvoproduct Note If Authentication Only mode is enabled for your tenant, mapping is only required for the User Id. Refer to step 8 for the details
- Custom attributes can be mapped by typing the attribute names in the Custom field separated by a comma.
- Configure a tenant admin account. This account does not require SAML authentication. This tenant admin can log directly into
providing a default security manager built-in admin.Frevvoproduct - The tenant admin id, password and email fields are required. The Change password on next login field is optional. It is checked by default.
- 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. For cloud customers the <base> is always https://app.frevvo.com.
- If the tenant based login url is used i.e. /frevvo/web/tn/{t}/login then SAML login is used.
The forgot password function works for a 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 and HTTP Authorization Credentials if required.
- Click Submit.
...
Warning | ||
---|---|---|
It is important to know that a SAML tenant with Authentication Only unchecked, means that authentication and authorization are handled by SAML/LDAP. Users are added/updated through discovery. If a tenant admin modifies user information in the Discovery updates only occur when the user logs into the tenant. The admin "login as" feature will not execute a discovery update. |
Section 6 - Logging into a Live Forms SAML Tenant
...
Browse the URL below to initiate the SAML authentication process by redirecting to the Identity Provider login page.
Cloud Customers:https://app.frevvo.com:443/frevvo/web/tn/{t}/login
...
. Replace {t} with the name of your 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 SAML tenant.
Note | |
---|---|
|
...
This URL redirects to /web/saml/login/alias/{t}. This initiates the SAML authentication process by redirecting to the Identity Provider login page. If the user is authenticated, the rest of the standard login processing is done (verify license, redirect on success etc).
Note | ||
---|---|---|
|
SAML Tenant Built-in Admin User
Just a reminder that the tenant admin account can login directly into Live Forms or use the SAML login.
...
|
Warning |
---|
sameSiteCookies attributePlease see this documentation on the use of the sameSiteCookies attribute to ensure compatibility with your SAML configuration. |
SAML Tenant Built-in Admin User
Just a reminder that the tenant admin account can login directly into Live Forms or use the SAML login.
When you create/edit a new tenant you are prompted to set up/modify a tenant admin user id, password and email address. This tenant admin does not authenticate via your SAML IDP. It only exists in Live Forms. If you experience an issue with your SAML configuration such that you can't login as an SAML authenticated user, use this this account to login to your tenant as a tenant admin in order to fix your SAML configuration issue. Only one built-in tenant admin account is supported.
...
- 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 SAML
Info |
---|
Embedding forms and flows workflows into your website (and other use of the Link (Email/Webpage) share URL) is NOT supported if the the visibility of the form is set to Public in Tenant and the user is NOT already authenticated to 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. |
Automating the Daily CSV Upload
Customer's using the SAML Security Manager, often want to schedule a daily upload batch job to automatically handle the synchronization between their Active Directory and
Frevvoproduct |
---|
Retrieving Custom Attributes from LDAP in a SAML Tenant
Similar to the LDAP Security Manager, custom properties in Active Directory for the logged in user can be made available so you can pull them into your form/flow using a
business rule. Attributes have to be configured and released in your IDP configuration for them to be available on login.There are several steps that have to happen to accomplish this: Frevvoproduct
...
Users will see an error like this one if you open your browser's console: Refused to display 'https://....' in a frame because it set 'X-Frame-Options' to 'deny'. |
Tip |
---|
If the tenant is using a SAML security manager, always use the Raw form link (see this documentation) to access your forms. This link will not load the form in a frame and login will work as expected. If you are embedding your forms inside another website, then make certain that user has to login to IDP before they can see that web page. If the user is already logged in, the form will load correctly (even inside a frame). |
Automating the Daily CSV Upload
Customer's using the SAML Security Manager, often want to schedule a daily upload batch job to automatically handle the synchronization between their Active Directory and
Frevvoproduct |
---|
Retrieving Custom Attributes from LDAP in a SAML Tenant
Similar to the LDAP Security Manager, custom properties in Active Directory for the logged in user can be made available so you can pull them into your form/flow using a
business rule. Attributes have to be configured and released in your IDP configuration for them to be available on login.There are several steps that have to happen to accomplish this: Frevvoproduct
- Make sure Authentication Only is unchecked in your SAML tenant.
- Make sure the custom attribute(s) are configured in Active Directory and assigned to the correct users.
Configure and release the custom attributes as SAML attributes in your IDP.
Tip The procedure to expose custom attributes will differ depending on the IDP you have selected. Refer to your IDP documentation or your on-staff IDP expert to complete this step.
- Map the attribute with this name in the Custom section of the tenant setup screen.
- You can do this when you are creating your SAML tenant or by accessing the Edit Tenant link, after signing on as the tenant admin of your existing SAML tenant.
- Save the tenant configuration.
- Write a
business rule to populate controls in your form/flow with the information.Frevvoproduct
...
Internet Explorer - You may see "site is not secure" or "Content was blocked because it was not signed by a valid security certificate" - skip these warnings to see the login page.
SAML Errors
The table below lists errors you may encounter when configuring your tenant with the SAML Security Manager. Verify the recommended values to resolve.
Parameters | Value to Verify | Error on Edit Tenant Page | Error While Accessing Tenant |
---|---|---|---|
SP Metadata | random | org.opensaml.xml.parse.XMLParserException: Invalid XML | NA |
<md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" ID="http___example.com_8082_frevvo_web_alias_saml" entityID="http://example.com:8082/frevvo/web/alias/saml"> </md:EntityDescriptor> | No error while adding/editing tenant | Application Error when accessing the login URL javax.servlet.ServletException: org.opensaml.saml2.metadata.provider.MetadataProviderException: No local entity found for alias saml, verify your configuration. Logs : Same excception with stack | |
Change domain name to something else e.g. example.com to localhost in the original metadata generated | No error while adding/editing tenant | UI : Web Login Service - Unsupported Request The application you have accessed is not registered for use with this service. Logs : No Error | |
In case the certificates in metadata are invalid and we need to regenerate the metadata. | No error while adding/editing tenant | Web Login Service - Message Security Error | |
IdP metadata | Some syntax error in xml | org.opensaml.xml.parse.XMLParserException: Invalid XML | NA |
Removed certificates(tag : <ds:X509Certificate>) from IdP metadata xml | No error while adding/editing tenant | UI: Access Denied. Authentication required. Logs : 2017-11-02 16:54:25.904 WARN saml 9c539fc6-1afb-4bb7-987f-6fd38b8e260f 7584 --- [http-nio-8082-exec-1] com.frevvo.forms.web.LoginResource : Login failure org.springframework.security.authentication.AuthenticationServiceException: Incoming SAML message is invalid | |
User Id | Wrong value | No error while adding/editing tenant | The IdP login page appears. After login following error on UI: Application Error Could not save user null; SQL []; Cannot insert the value NULL into column 'userId', table 'frevvo74.dbo.users'; column does not allow nulls. INSERT fails.; nested exception is com.microsoft.sqlserver.jdbc.SQLServerException: Cannot insert the value NULL into column 'userId', table 'frevvo74.dbo.users'; column does not allow nulls. INSERT fails. Logs: Same exception with stack trace |
First Name | Wrong value | No error while adding/editing tenant | No Error in accessing and using tenant. The firstname remains blank in edit user page. NULL in firstname colum in users table |
Last Name | Wrong value | No error while adding/editing tenant | No Error in accessing and using tenant. The firstname remains blank in edit user page. NULL in firstname colum in users table |
Wrong value | No error while adding/editing tenant | Application Error Could not update user (not password): dl in tenant: saml (id=1020); SQL []; Cannot insert the value NULL into column 'email', table 'frevvo74.dbo.users'; column does not allow nulls. UPDATE fails.; nested exception is com.microsoft.sqlserver.jdbc.SQLServerException: Cannot insert the value NULL into column 'email', table 'frevvo74.dbo.users'; column does not allow nulls. UPDATE fails. Logs : Same Error with stack | |
Manager User Id | Wrong value | No error while adding/editing tenant | reportsTo column in DB set to NULL. No error anywhere. |
Groups | Wrong value | No error while adding/editing tenant | IdP login appears. After entering credentials, following error is seen and user can not login: Access Denied. Either you are not authenticated or you do not have the proper permissions/role. Logs: 2017-11-02 15:48:38.836 WARN saml 15805e17-2a04-43dc-9d91-298da764a915 7584 --- [http-nio-8082-exec-9] com.frevvo.forms.web.LoginResource : Could not login dl: Access Denied. Either you are not authenticated or you do not have the proper permissions/role. |