HMSyncTOC("index.html", "configure_adfs_saml.htm");

Configure ADFS using SAML 2.0

<< Click to Display Table of Contents >>

Configure ADFS using SAML 2.0

 

Configure ADFS using SAML 2.0

  •     Overview
  •     Before You Start
  •     1. Generate certificates to sign assertions (mandatory)
  •     2. Configure your IdP in the Customer Portal
  •     3. Configure Bizagi as Service Provider in ADFS
  •         Set the Secure Hash Algorithm in ADFS 3
  •         Additional step for self-signed certificates
  •     Troubleshooting
  • 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 Microsoft ADFS.

    This section is a step-by-step guide to configuring in ADFS and in Bizagi to have an integrated authentication in Bizagi against ADFS.

     

    SAML_ADFS_OV

     

    For SAML 2.0, the your Identity Provider must be set up to support HTTPS.

     

    Before You Start

    To configure ADFS supporting SAML 2.0, you need:

     

    An installed and fully configured and supported version of ADFS.

    Bizagi supports ADFS version 3.0 or 4.0.

    If you want to use a different version which supports SAML 2.0, check with our support team before proceeding.

     

    To configure your Identity Provider you must follow these steps:

     

    1. Generate certificates to sign assertions (mandatory)

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

    If you need some guidance or an example on this step, refer to Certificates for SAML 2.0 authentication.

     

    To proceed with these guided steps, you need to have:

    One certificate to sign assertions (mandatory) in .P12 or .PFX  file format. You need The password for the certificate file, as defined by you when you exported the public and private keys.

    One certificate to encrypt messages (optional) in .P12 or .PFX  file format. You need The password for the certificate file, as defined by you when you exported the public and private keys.

     

    note_pin

    You will need to be in charge of managing your installed certificates (keep track of its expiration date and other relevant maintenance aspects such as changes in your Identity Provider's endpoints).

     

    2. Configure your IdP in the Customer Portal

    After you configure the application in Azure AD, now you must access the Bizagi Customer Portal and register the Identity Provider. Follow the steps in Configure a SAML 2.0 IdP in the Customer Portal.

     

    3. Configure Bizagi as Service Provider in ADFS

    Do this in the admin options in ADFS.

     

    3.1. In your ADFS server, open the administration console.

     

    3.2. Launch the creation of a relying party trust.

    Right-click Relying party trust to display the options menu, and select the configuration wizard:

     

    SSO_idp0

     

    Select Claims aware and Click Start.

     

    ADFS_15

     

    3.3. Select the data source.

    To configure the relying party, select the Import data about the relying party from a file option and browse for the metadata file generated by Bizagi. After you configure the identity provider in Bizagi's Customer Portal, you must generate the metadata file. Refer to Download the metadata file.

     

     

    ADFS_16

     

    Click Next when done.

    3.4. Enter a unique name.

    Give a display name to this configuration, for your convenience.

     

    ADFS_17

     

    Click Next when done.

     

    3.5 Configure the Issuance Authorization rules by choosing the Permit all users to access this relying party option.

     

    ADFS_18

     

    You see a summary of the information to set for this relying party trust, including the information that came from Bizagi's metadata file.

     

    ADFS_19

     

    You may click Next when done.

    You may also check (in the Advanced view) that the algorithm set for this use (either SHA1 or SHA256), matches the one configured in Bizagi.

     

    3.6 Create the Claim rules for this trust by selecting the Configure claims issuance policy for this application.

    This way, upon trust creation you immediately create a claim rule and finish the configuration.

     

    ADFS_20

     

    Then click Close.

     

    3.7. Right click the Party Trust created and click Edit Claim Issuance Policy.

     

    ADFS_21

     

    Define a new claim rule by clicking Add Rule.

     

    ADFS_22

     

     

    Make sure you can send UPN, Email address and Name as information within the claim that is passed into the Customer Portal.

    For instance, you can create a new claim rule by choosing the Send LDAP Attributes as Claims template:

     

    ADFS_1_12

     

    Click Next.

     

    Configure the rule by giving it a name, and explicitly including:

    Attribute store: Attribute Directory.

    Mapping of LDAP attributes to outgoing claim types, including:

    oUser-Principal-Name mapped to the UPN

    oEmail-Addresses mapped to the E-mail Address.

     

    note_pin

    Bizagi considers the following priority in the assertions:

    1. UPN

    2. Email

     

    Both UPN and Email Address must be in email format:  [name]@[provider].[domain]. For example john.smith@mycompany.com.

     

    For the UPN claim type make sure that the email is defined as the user name.

     

    ADFS_1_13

     

    Click Finish.

    You should have a registered claim rule for your specific relying party configuration.

    Once you have verified this is correct, click OK.

     

    Set the Secure Hash Algorithm in ADFS 3

    If you are using ADFS 3 make sure that the Secure Hash Algorithm is SHA-256. To change that, right-click the client created previously and select properties.  Click the Advanced tab and select SHA-256 as the Secure Hash Algorithm.

     

    Additional step for self-signed certificates

    If you have issued and installed a self-signed certificate for your ADFS for signing and encrypting purposes, you will need to perform the following:

    1.Access your ADFS server and open a PowerShell console.

    2.Enter the following command:

     

    Get-AdfsRelyingPartyTrust -Identifier [relying_party_trust] | Set-AdfsRelyingPartyTrust

    -SigningCertificateRevocationCheck None -EncryptionCertificateRevocationCheck None

     

    Replace [relying_party_trust] accordingly to the unique name given at the configuration above (when you register Bizagi's relying party trust).

     

    To test your configuration we recommend that all users log out and opening a new tab using incognito mode, or use a different browser. If the configuration with a new IdP fails, you can Restore the authentication protocol.

     

    Troubleshooting

    In case the authenticator fails, you can review:

    Troubleshooting SAML message exchanges

    SAML Error codes

    In this article