Authentication with Okta

<< Click to Display Table of Contents >>

Navigation:  Identity and access management > SAML authentication >

Authentication with Okta

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 Okta.

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

 

SAML_Okta_OV

For SAML 2.0, both your Identity Provider and your Bizagi project need to support HTTPS.

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

 

 

Prerequisites

To configure Okta you need:

 

1. To have previously generated and imported your own certificates

The integration uses the for signing assertions.

This step is not bound to Bizagi nor restricted by any special requirement of Bizagi (you usually do it yourself).

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

 

To proceed with the guided steps below, you need to have already imported certificates in your Identity Provider. You need the following information:

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.

 

note_pin

You need to be in charge of managing your installed certificates (tracking expiration dates and responding to any other maintenance requirements such as changes in your Identity Provider's endpoints).

 

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

When integrating any Identity Manager you must synchronize user accounts that are authorized to access Bizagi's Work portal.

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

Bizagi does not store passwords when integrating with an Identity Manager.

 

Once you have verified in the Work Portal that there has been at least an initial import of your users into Bizagi, you may proceed:

 

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 user identifier.

 

What you need to do

 

1. Configure in Bizagi the settings that make reference to the specification of your SAML setup.

2. Configure Bizagi as Service Provider in Okta.

 

Procedure

 

1. Configure in Bizagi the settings that make reference to the specification of your SAML setup.

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

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

 

1.1. Open the Bizagi Management Console and open your Bizagi project.

 

UsingStudio01

 

1.2. In the Security module and click the Authentication option found under the Security item.

Select Federated authentication from the drop-down list in the panel to the right, and SAML v2.0 from the drop-down at the bottom right:

 

SAML_Bizagiparams1

 

Click Update.

You will get a confirmation message. Additional parameters appear under the Authentication item.

 

note_pin

If you applied this change into an environment other than development, make sure to apply the same changes in your development environment.

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

 

1.3. Configure the additional parameters as described below. Click Update for each one that you modify.

Parameter values are case-sensitive. Make sure you provide them accurately.

 

Configure these settings:

Enable assertion encryption: Leave this checkbox unchecked (set to Off). Okta does not currently support reception of encrypted assertions.

Enable authentication logging in database: Check this checkbox (set to On) to require the web application to log every authentication event, according to your auditing requirements and expectations. You can review the log in your Work portal.

Encryption certificate: Disregard this setting since Enable assertion encryption is disabled.

Encryption certificate password: Disregard this setting since Enable assertion encryption is disabled.

Force authentication: Check this checkbox (set to On) to disable SSO capabilities so that every time users attempt log in at Bizagi, they have to provide their credentials. Use the setting that matches to your authentication requirements and expectations.

Identity Provider Metadata File Path: Provide the path to the Okta metadata file. This location is typically an URL.

However, configuration for this setting with Okta is not done in a single step.

Okta will not issue its metadata file location before Bizagi is configured. As with Bizagi, you generate the metadata file of these settings to use later in Okta.

For now, leave this setting blank in Bizagi, and generate Bizagi's metadata file.

Once you can use Bizagi's metadata file to move on with the configuration in Okta, you can obtain Okta's metadata URL and come back to this option to provide the URL for this setting.

Idle sessions time-out: Define the number of minutes of inactivity after which a session expires, according to your authentication requirements and expectations (e.g, 5 minutes).

Organization name: Provide the name of your organization. It is included within the request messages sent by Bizagi.

Organization URL: Provide the URL of the website of your organization.It is included within the request messages sent by Bizagi.

SAML Protocol Binding for SLO: We recommend selecting POST to support for long messages.

SAML Protocol Binding for SSO: We recommend selecting POST to support for long messages.

Service provider URL: Provide the full URL (including the project) for your Bizagi Work portal.

For Automation Service, the URL has this format:

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

For on-premises projects, the URL has this format:

https://[server]/[project]

The URL is case-sensitive and [environment]- should be disregarded (left as blank) for a production environment.

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

This password should match the one you defined when you exported the information in P12 format.

Signing algorithm: Select either SHA1 or SHA256.

Signing certificate: Use the Browse button to locate and 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 your changes have been applied.

 

note_pin

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

 

1.4. Perform a reset on your Bizagi services.

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

Any change in the authentication type, or any of its settings, are not reflected until the cache of the application server is explicitly refreshed.

 

1.5. Browse for the location of the metadata file that Bizagi generates based on the previous configuration.

To configure Okta more easy in the next steps, Bizagi downloads the metadata file into a local path so you can use it as input in Okta.

 

You can review this metadata file by browsing it at:

https://[environment]-[project]-[company].bizagi.com/saml2/metadata.xml?mode=preview

 

Download the file by inputting in your browser:

https://[environment]-[project]-[company].bizagi.com/saml2/metadata.xml?mode=attachment

 

2. Configure Bizagi as Service Provider in Okta

 

2.1. Log in with admin rights to your Okta portal.

 

2.2. Locate the Applications menu and from it to select Applications.

Then click Add Application:

 

Okta_1

 

2.3. Click Create New App.

 

Okta_2

 

 

2.4. Provide the following details:

Platform: Select Web.

Sign on method: Click SAML 2.0.

 

Okta_3

 

Click Create when done.

 

2.5. Go to the Create SAML integration section.

 

2.6. Fill out General settings:

App name: Provide unique name for your app.

App logo: Select a representative for your app.

 

Okta_4

 

 

Click Next when done.

 

2.7. Fill out Configure SAML:

 

Single Sign on URL: Provide the URL of your Bizagi Work portal followed by the /saml2/assertionConsumer suffix.

For Automation Service, the URL has this format:

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

For on-premises projects, the URL has this format:

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

 

Use this for Recipient URL and Destination URL: Check this option.

 

Audience URI (SP Entity ID): Provide the URL of the Bizagi Work portal just configured in Bizagi Studio (or the Bizagi Management Console).

For Automation Service, the URL has this format:

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

For on-premises projects, the URL has this format:

https://[server]/[project]/

 

Use this for Recipient URL and Destination URL: Check this option.

Default RelayState: Leave empty.

Name ID format: Select E-mailAddress.

Application Surname: Select E-mail.

 

Okta_5

 

2.8. Fill out Show Advanced Settings:

Response: Select Signed.

Assertion Signature: Select Signed.

Signature Algorithm: Select RSA-SHA1 or RSA-SHA256, according to the one configured in Bizagi.

Digest Algorithm: Select SHA1.

Assertion Encryption: Select Encrypted.

Encryption Algorithm: Select AES256-CBC.

Key Transport Algorithm: Select RSA-1.5.

Encryption Certificate: Browse for the public certificate for encryption purposes and upload it.

Enable Single Logout: Select Allow application to initiate Single Logout.

Single Logout URL: Provide the URL of the Bizagi Work portal followed by the /saml2/logout suffix.

For Automation Service, the URL has this format:

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

For on-premises projects, the URL has this format:

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

 

SP Issuer: Enter the URL of the Bizagi Work portal just as it was configured in Bizagi Studio (or the Bizagi Management Console).

For Automation Service, such URL uses this format:

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

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

https://[server]/[project]/

Signature Certificate: Browse for the security certificate for signing purposes and upload it.

Authentication context class: Select PasswordProtectedTransport.

Honor force authentication: Select Yes.

SAML Issuer ID: Leave the default value as generated by Okta.

 

Okta_6

 

Click Next when done.

 

Okta_7

 

2.9. Leave the defaults and empty fields for other options and click Next.

 

Okta_8

 

You can preview how the assertion would be set in runtime:

 

Okta_9

 

2.10. In the Feedback tab, you may choose to set:

Are you a customer or partner?: Select I'm an Okta customer adding an internal app.

App type: Check the This is an internal app that we have created checkbox.

 

Okta_10

 

Click Finish when done.

 

2.11. Finally, once the app is created, browse to its details and into the Sign On tab.

 

2.12. Select the hyperlink labeled as Identity Provider metadata.

 

Okta_11

 

 

You need to copy this URL so that, in Bizagi, you can set the Identity Provider Metadata File Path setting to point to it.

 

SAML_Bizagiparams2PingF