Section | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Required: 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
Optional: There are two additional roles in - frevvo.Publisher and frevvo.ReadOnly. These roles are optional.
- In order to give a user the frevvo.publishers role, create the the frevvo.Publisher group in your AD and assign users to it. Refer to the Publisher Role Documentation for an explanation of this role.
- In order to give a user the frevvo.ReadOnly role, create the frevvo.ReadOnly group in your AD and assign users to it. Following frevvo Best Practice eliminates the need for this role.
Warning |
---|
|
...
If you are familiar with the Microsoft Azure Legacy Portal, review this Microsoft Training Guide before setting up the Azure application for .
...
for .
Info |
---|
Do not include the curly braces in the URLs discussed below. |
- Login to the Microsoft Azure Management console: https://manage.windowsazure.com or https://portal.azure.com with your Azure global administrator account.
Click on the Azure Active directory link on the left side of the screen.
Click on the App Registrations link.
Click on the New application registration link for creating a new application.
- Enter the following details:
- Name:- Name of your frevvo Azure application
- Select who can use this application or access this API
- Configure the Redirect URL:
Cloud Customers should use https://app.frevvo.com:443/frevvo/web/saml/SSO/alias/{t} - replace {t} with name of your frevvo tenant.
Info For example, if you were changing the Security Manager from the Default Security Manager to the Azure SAML Security Manager for a frevvo Cloud tenant named mycompany.com, the REPLY URL would be:
https://app.frevvo.com:443/frevvo/web/saml/SSO/alias/mycompany.com
On-premise customers should use http://<server>:<port>/frevvo/web/saml/SSO/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 in-house tenant.
Info For example, if you were changing the Security Manager from the Default Security Manager to the Azure SAML Security Manager for a frevvo in-house tenant named mycompany.com, the REPLY URL would be:
https://<server:port>/frevvo/web/saml/SSO/alias/mycompany.com
- Click Register.
- Select the frevvo application from the list.
- Click the Branding tab
- Configure the Home Page URL:
Cloud Customers should use https://app.frevvo.com:443/frevvo/web/tn/{t}/login - replace {t} with the name of your frevvo Cloud tenant.
Info For example, if you were changing the Security Manager from the Default Security Manager to the Azure SAML Security Manager for a frevvo Cloud tenant named mycompany.com, the SIGN-ON URL would be:
https://app.frevvo.com:443/frevvo/web/tn/mycompany.com/login
On-premise customers should use http://<server>:<port>/frevvo/web/tn/{t}/login - replace <server> with the ip of your server, <port> with the port number (if applicable) and t with the name of your frevvo in-house tenant.
Info For example, if you were changing the Security Manager from the Default Security Manager to the Azure SAML Security Manager for a frevvo in-house tenant named mycompany.com, the SIGN-ON URL would be:
- Click Save.
- Click on the API Permissions tab.
- Click Add a Permission.
- Select Microsoft Graph.
- For Application Permissions, select Directory.Read.All and Directory.ReadWrite.All (under Directory).
- For Delegated Permissions, select User.Read. (This permission may already be present.)
- Click on the Grant Permissions button select "Yes" option and click on the Save button.
- Click on the Expose an API tab.
- Click Add a Scope. See this Microsoft Azure documentation for details.
By default, Azure provides the ApplicationID URI as api://<appId>.For example
Code Block api://3f2fd3fd-67f5-423e-95bc-c01d3712966c
You may use a different AppID URI if desired. This table lists supported* formats:
api://<appId>
api://<tenantId>/<appId>
api://a8573488-ff46-450a-b09a-6eca0c6a03ed/fc4d2d73-d05a-4a9b-85a8-4f2b3a5f39fe
api://<tenantId>/<string>
api://<string>/<appId>
*See this Microsoft documentation for additional available formats. frevvo has not verified with every format, so please use those not listed here with caution.
- Click Save and Continue.
- Provide the required attributes and choose a consent option. Usually this will be Admins and Users.
- Click the Certifiates & secrets tab.
Generate the Client Secret.
...
Copy the new secret's Value and save it in a notepad - you will need this for the frevvo tenant screen.
...
- Click the Overview tab.
- Copy the Application ID into your notepad. This is the value of the Client ID on the frevvo configuration screen.
Copy the Directory ID into your notepad. This is the value of the Tenant ID on the frevvo configuration screen.
Click Endpoints at the top of the screen. Copy the Federation Metadata Document URL from the list to your notepad. This is the URL that you will use to generate the Azure metadataCode Block title Example of the Federation Metadata Document URL https://login.microsoftonline.com/3d532ac1-a43c-45c7-b0e9-cc814400ca11/federationmetadata/2007-06/federationmetadata.xml
- Proceed to Step 2 - Create the frevvo metadata file
Warning |
---|
Just a reminder - you will need the Azure tenant ID, the client id and client secret for the frevvo application when configuring your Azure SAML tenant.SAML tenant. We recommend making a note of your Client Secret expiration date. You will need to refresh it prior to the expiration to ensure continued access to frevvo. See this Microsoft article for details. |
Step 2 - Create the frevvo 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.
Edit the .xml file. Replace the entityID property (shown here on line 2) with the AppId URI (see Step 1 bullet #11) from Azure. For example, the generated entityID will look like this
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" ID="https___localhost_8443_frevvo_web_alias_testazuread"
entityID="https://staging-app.frevvo.com:443/frevvo/web/alias/qateam_azure"> |
Replace the generated entityID with your AppId URI like this
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" ID="https___localhost_8443_frevvo_web_alias_testazuread"
entityID="api://d8447c40-ac18-487c-a9a1-dc63d9f4a866"> |
Copy the entire metadata from this file to the Azure SAML Security Manager configuration screen.
Tip |
---|
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.
Code Block | ||
---|---|---|
| ||
https://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:
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.
Code Block | ||
---|---|---|
| ||
https://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 .
- The tenant admin id, password and email fields are required. The Change password on next login 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 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 notification and reminder emails.
Enter HTTP Auth credentials if required. Credentials for external secure web services accessed by the forms and workflows in your tenant can be specified in this section.
Click Submit.
Step 5 - Logging into a frevvo 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 Projects 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.
Note |
---|
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. Cloud customers browsing app.frevvo.com or in-house customers browsing http://<servername>:<port>/frevvo/web/login attempting to log into an Azure tenant directly (user@saml tenant name) will automatically be redirected to the Azure IDP login page. |
Logged in User Display in Azure SAML frevvo 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 . 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 Built-in Admin User
Just a reminder that the tenant admin account can login directly into frevvo or use the Azure 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 Azure SAML IDP. It only exists in frevvo. If you experience an issue with your Azure SAML configuration such that you can't login as an Azure SAML authenticated user, use the built-in admin user to login to your tenant as a tenant admin in order to fix your Azure SAML configuration issue. Only one built-in tenant admin account is supported.
Browse this URL to login as the built-in: <base_URL>/frevvo/web/admin/login. When specified, will prepend the base URL to the URLs in your Form/Document Actions. The <base_URL> is typically http(s)://<your servername>:<port>.
You must use the admin specific URL - <base-url>/frevvo/web/admin/login - to login as the built-in.
Non admin users can also login using the admin specific URL.
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 :
Browsing the admin specific URL - <base-url>/frevvo/web/admin/login. Enter the built-in userid. Click Forgot Password? This error message displays if any other user clicks on the Forgot Password? link after browsing the admin specific URL:
Logging in as a Azure SAML authenticated tenant admin and changing the password via Manage Users.
Tip |
---|
The frevvo superuser admin (Cloud customers) and the in-house superuser can change the password for the built-in userid from the Edit Tenant page. |
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.
Tip |
---|
The frevvo (Cloud customers) and in-house superuser can see the built-in tenant userid from the Edit Tenant page. |
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 and workflows 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
Info |
---|
Embedding forms and workflows 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. |
...
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/workflow 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/workflow with fields to collect the information.
Write a business rule to populate the controls with the custom attribute information.
Section | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
At least one designer user that is going to be connecting forms/workflows 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 .
Troubleshooting
Application Error Logging in the Azure SAML tenant
If you see an application error when logging in and an error message, "Caused by: org.opensaml.common.SAMLException: InResponseToField of the Response doesn't correspond to sent message", in the logs, your Azure secret key may have expired. See this article for steps to renew it. Then update the frevvo tenant (Step 4 above).
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.
...
Code Block |
---|
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 frevvo Azure SAML tenant may encounter the error "Access Denied. Authorization Required". Examination of the frevvo.log shows the following entry:
Code Block |
---|
Response issue time is either too old or with date in the future, skew 60, time 2016-06-01T05:49:25.330Z |
This error is typically caused by a clock synchronization issue between the SP (frevvo) and the Idp (Azure) or a genuine delay in the connection. If you get this error, you can change the value of the context parameter, com.frevvo.security.saml.response.skew, to specify the time in seconds allowed between the SAML request and response to a value greater than the default value of 60 seconds.
Follow the instructions listed in the Installation Tasks chapter to add the parameter.
...