Authentication with Azure AD

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Security definition > Work Portal Security > Authentication > SAML authentication >

Authentication with Azure AD

Overview

Bizagi supports integration with Identity and Access Management systems (i.e, Identity Managers or Identity Providers) which are SAML 2.0 compliant, such as Azure AD.

This section is a step-by-step guide about the configuration needed, both in Azure AD and in Bizagi, in order to have an integrated authentication in Bizagi against Azure AD.

 

SAML_Azure_OV

 

Notice that for SAML 2.0, it is required that both your Identity Provider and your Bizagi project are strictly set up to support HTTPS.

For introductory information about SAML 2.0, refer to Authentication via SAML.

 

Prerequisites

In order to configure Azure AD, as with any Identity Provider supporting SAML 2.0, you will need:

 

1. To have previously generated and imported your own certificates.

Such certificates are employed in this integration for the purpose of signing assertions.

This step is not bound to Bizagi nor restricted by any special requirement of Bizagi (it is usually carried out on your own).

In case that you need some guidance or an example on this step, refer to Generating and installing certificates.

 

In order to proceed with the guided steps presented below, you will need to have already imported certificates the in your Identity Provider. From such exercise, the following resulting input is needed as well:

The certificate information (.p12 file).

The password for that .p12 file, as defined by you at the moment of exporting the public and private key.

 

Recall that if you will be encrypting assertions as well, then the above is also needed for another certificate.

 

note_pin

Consider that the above implies that you will need to be in charge of managing your installed certificates (and watching after its expiration date or any other relevant maintenance aspects such as watching after any changes in your Identity Provider's endpoints).

 

2. To have already imported and synchronized your users into Bizagi.

Recall that when integrating any Identity Manager (regardless of the chosen one), customers need to synchronize those accounts that are authorized to access Bizagi's Work portal.

Synchronizing means importing or updating the account's primary identifier only (domain plus username typically, and the e-mail).

Recall that passwords are not stored when integrating an Identity Manager.

 

Once you have verified that at least there is an initial import of your users into Bizagi, you may proceed (by relying on the Work portal and its admin menu):

 

125Users13

 

note_pin

In Bizagi, unique identifiers for users are either: e-mail, or the combination of domain and username.

The examples of SAML-based authentication provided below use e-mail as the unique identifier for users.

 

What you need to do

The following outline of steps describes what needs to be done, both at Bizagi and at Azure AD:

 

1. Configuring Bizagi as Service Provider in Azure AD.

2. Configuring in Bizagi, the settings that make reference to the specification of your SAML setup.

 

Procedure

Follow these steps:

 

1. Configuring Bizagi as Service Provider in Azure AD

Do this by going into the admin options as provided by Azure AD.

 

1.1 Log in to your Azure services with admin rights.

Access your Azure subscription with the Azure AD service.

To do so, you will need to sign in to Azure's portal at https://portal.azure.com.

 

AzureAD_portal01

 

1.2. Go into your Active Directory.

Click on Active Directory option at the left panel and click your on App registrations to then add a new application to it (by clicking New application registration).

 

Azure_auth1

 

1.3. Input the app's basic details

Give this app a name, and select Web App / API for its type.

For its Sign-on URL note that you need to input the base URL where your end users access Bizagi Work portal.

 

Consider:

For Bizagi PaaS (cloud projects), this URL is specified as:

https://[project_environment]-[your_project]-[your_company].bizagi.com

While replacing [your_company] and [your_project] for your subscription's values accordingly.

Similarly, replace [project_environment] with test for a testing environment, or with nothing at all for a production environment.

 

For <%ONPREMISES%> Bizagi projects, this URL is specified as:

https://[your_server]/[your_project]

While replacing [your_server] and [your_project] depending on how you set up your environment.

 

Azure_auth2

 

Click Create when done.

 

1.4. Go into the details of your app.

Once the app is created, click on it to go into its details and then enter its settings.

 

Azure_auth3

 

1.5. Click on Properties.

 

AzureAD_4

 

1.6. Configure the App ID URI so that it references the Bizagi Work portal.

For Bizagi PaaS, such URL uses this format:

https://[environment]-[project]-[company].bizagi.com/

For on-premises projects, such URL uses this format:

https://[server]/[project]

 

AzureAD_5

 

Leave other values blank or with defaults.

 

1.7. Click on Reply URLs and edit the appearing default URL so that it references the Bizagi Work portal with the /saml2/assertionConsumer suffix.

For Bizagi PaaS, such URL uses this format:

https://[environment]-[project]-[company].bizagi.com/saml2/assertionConsumer

For on-premises projects, such URL uses this format:

https://[server]/[project]/saml2/assertionConsumer

 

AzureAD_6

 

Click on Save when done.

 

1.8. Look up your endpoints

Go back to App registrations and look up the Endpoints in order to gather the URL of the metadata location that you will need later on for configuration in Bizagi.

 

AzureAD_7

 

 

note_pin

Adequate authorization settings are usually set Ok by default, which means you should not need to configure this setting.

By default the new applications and their keys are granted with Sign in and read user profile, which is what Bizagi requires.

Notice it is Ok that this setting does NOT require Admin:

 

Azure_auth10

 

At this point, configuration directly in Azure AD is set and you may now go to Bizagi to complete the procedure.

 

2. Configuring in Bizagi, the settings that make reference to the specification of your SAML setup.

Do this by using Bizagi Management Console targeting the environment you want this configuration to apply to (e.g, development environment, testing environment, production environment).

Alternatively and only for the development environment, you may use Bizagi Studio.

 

2.1. Open Bizagi Management Console and open your Bizagi project.

 

UsingStudio01

 

2.2. Locate the Security module and click on the Authentication option found under the Security item.

Then select Federated authentication from the drop-down list in the panel to the right, and select SAML v2.0 from the drop-down right below:

 

SAML_Bizagiparams1

 

Click Update.

You will get a confirmation message and notice that additional parameters appear under the Authentication item.

 

note_pin

If you applied this change into an environment other than development, then you should also make sure such same changes are applied in your development environment as well.

To do this, follow the same procedure mentioned above while using the Bizagi Management Console.

 

2.3. Proceed to configure these additional parameters as described below, ensuring you click Update for each one that is modified.

Note that the parameter values are case-sensitive and therefore you will need to ensure you input these correctly.

 

Fill in or configure these settings as described:

Enable assertion encryption: You may tick this checkbox (set to On). If doing so, ensure you configure Encryption certificate and Encryption certificate password.

Enable authentication logging in database: You may tick this checkbox (set to On) to define if the web application must log every authentication event (viewed from the Work portal), according to your auditing requirements and expectations.

Encryption certificate: Use the Browse button to upload the digital certificate (in P12 format, containing the public and private key) that will be used to encrypt the assertions generated by Bizagi.

Encryption certificate password: Type the password of the digital certificate used for the encryption of assertions.

This password should match the one defined by you at the moment of exporting a certificate information in P12 format.

Force authentication: You may tick this checkbox (set to On) to avoid SSO capabilities so that every time users attempt login at Bizagi, credentials are explicitly requested. Decide on this according to your authentication requirements and expectations.

Identity Provider Metadata File Path: Type the path where the Azure AD metadata file is located. This location is typically an URL. Such URL in Azure AD is usually found at:

https://login.microsoftonline.com/[tenant]/federationmetadata/2007-06/federationmetadata.xml ;where you will need to acknowledge the id of your tenant/subscription (as copied into clipboard in the first steps in Azure AD).

Idle sessions time-out: Define the minutes for which a session will expire, according to your authentication requirements and expectations (e.g, 5 minutes).

Organization name: Type the name of your organization. Such information is included within the request messages sent by Bizagi.

Organization URL: Type the URL of the website of your organization. Such information is included within the request messages sent by Bizagi.

SAML Protocol Binding for SLO: It is recommended to select POST so that there is support for much lengthier messages.

SAML Protocol Binding for SSO: It is recommended to select POST so that there is support for much lengthier messages.

Service provider URL: Type the full URL (including the project) of the Service Provider. This means entering the URL for Bizagi Work portal.

For Bizagi PaaS, such URL uses this format:

https://[environment]-[project]-[company].bizagi.com/

For on-premises projects, such URL uses this format:

https://[server]/[project]

Recall that the above URL is case-sensitive and that [environment]- should be disregarded (left as blank) while in a production environment.

Signature certificate password: Type the password of the digital certificate used for the signing of assertions.

This password should match the one defined by you at the moment of exporting a certificate information in P12 format.

Signing algorithm: Select either SHA1 or SHA256.

Signing certificate: Use the Browse button to upload the digital certificate (in P12 format, containing the public and private key) that will be used to sign the assertions generated by Bizagi.

Technical email contact address: Provide an e-mail address for contact with your corporation, regarding technical issues.

 

SAML_Bizagiparams2

 

Once you are done, review that changes have been applied.

 

note_pin

Authentication changes may not be reflected immediately; in which case, you may need to reset the Bizagi services.

 

2.4. Perform a reset on your Bizagi services.

For on-premises projects, this means executing an IISReset.

Recall that any change in the authentication type, or any of its settings, is not reflected immediately unless the cache of the application server is explicitly refreshed.

 

At this point you have configured your Azure AD to rely on SAML 2.0 for an integrated authentication with Bizagi!