Edit

Tutorial: Microsoft Entra SSO integration with Peakon

  • Article

In this tutorial, you'll learn how to integrate Peakon with Microsoft Entra ID. When you integrate Peakon with Microsoft Entra ID, you can:

  • Control in Microsoft Entra ID who has access to Peakon.
  • Enable your users to be automatically signed-in to Peakon with their Microsoft Entra accounts.
  • Manage your accounts in one central location.

Prerequisites

To get started, you need the following items:

  • A Microsoft Entra subscription. If you don't have a subscription, you can get a free account.
  • Peakon single sign-on (SSO) enabled subscription.

Note

This integration is also available to use from Microsoft Entra US Government Cloud environment. You can find this application in the Microsoft Entra US Government Cloud Application Gallery and configure it in the same way as you do from public cloud.

Scenario description

In this tutorial, you configure and test Microsoft Entra single sign-on in a test environment.

To configure the integration of Peakon into Microsoft Entra ID, you need to add Peakon from the gallery to your list of managed SaaS apps.

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.
  2. Browse to Identity > Applications > Enterprise applications > New application.
  3. In the Add from the gallery section, type Peakon in the search box.
  4. Select Peakon from results panel and then add the app. Wait a few seconds while the app is added to your tenant.

Alternatively, you can also use the Enterprise App Configuration Wizard. In this wizard, you can add an application to your tenant, add users/groups to the app, assign roles, as well as walk through the SSO configuration as well. Learn more about Microsoft 365 wizards.

Configure and test Microsoft Entra SSO for Peakon

Configure and test Microsoft Entra SSO with Peakon using a test user called B.Simon. For SSO to work, you need to establish a link relationship between a Microsoft Entra user and the related user in Peakon.

To configure and test Microsoft Entra SSO with Peakon, perform the following steps:

  1. Configure Microsoft Entra SSO - to enable your users to use this feature.
    1. Create a Microsoft Entra test user - to test Microsoft Entra single sign-on with B.Simon.
    2. Assign the Microsoft Entra test user - to enable B.Simon to use Microsoft Entra single sign-on.
  2. Configure Peakon SSO - to configure the single sign-on settings on application side.
    1. Create Peakon test user - to have a counterpart of B.Simon in Peakon that is linked to the Microsoft Entra representation of user.
  3. Test SSO - to verify whether the configuration works.

Configure Microsoft Entra SSO

Follow these steps to enable Microsoft Entra SSO.

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.

  2. Browse to Identity > Applications > Enterprise applications > Peakon > Single sign-on.

  3. On the Select a single sign-on method page, select SAML.

  4. On the Set up single sign-on with SAML page, click the pencil icon for Basic SAML Configuration to edit the settings.

    Edit Basic SAML Configuration

  5. On the Basic SAML Configuration section, if you wish to configure the application in IDP initiated mode, perform the following steps:

    a. In the Identifier text box, type a URL using the following pattern: https://app.peakon.com/saml/<companyid>/metadata

    b. In the Reply URL text box, type a URL using the following pattern: https://app.peakon.com/saml/<companyid>/assert

  6. Click Set additional URLs and perform the following step if you wish to configure the application in SP initiated mode:

    In the Sign-on URL text box, type the URL: https://app.peakon.com/login

    Note

    These values are not real. Update these values with the actual Identifier and Reply URL which is explained later in the tutorial. You can also refer to the patterns shown in the Basic SAML Configuration section.

  7. On the Set up Single Sign-On with SAML page, in the SAML Signing Certificate section, click Download to download the Certificate (Raw) from the given options as per your requirement and save it on your computer.

    The Certificate download link

  8. On the Set up Peakon section, copy the appropriate URL(s) as per your requirement.

    Copy configuration URLs

Create a Microsoft Entra test user

In this section, you'll create a test user called B.Simon.

  1. Sign in to the Microsoft Entra admin center as at least a User Administrator.
  2. Browse to Identity > Users > All users.
  3. Select New user > Create new user, at the top of the screen.
  4. In the User properties, follow these steps:
    1. In the Display name field, enter B.Simon.
    2. In the User principal name field, enter the username@companydomain.extension. For example, B.Simon@contoso.com.
    3. Select the Show password check box, and then write down the value that's displayed in the Password box.
    4. Select Review + create.
  5. Select Create.

Assign the Microsoft Entra test user

In this section, you'll enable B.Simon to use single sign-on by granting access to Peakon.

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.
  2. Browse to Identity > Applications > Enterprise applications > Peakon.
  3. In the app's overview page, select Users and groups.
  4. Select Add user/group, then select Users and groups in the Add Assignment dialog.
    1. In the Users and groups dialog, select B.Simon from the Users list, then click the Select button at the bottom of the screen.
    2. If you are expecting a role to be assigned to the users, you can select it from the Select a role dropdown. If no role has been set up for this app, you see "Default Access" role selected.
    3. In the Add Assignment dialog, click the Assign button.

Configure Peakon SSO

  1. In a different web browser window, sign in to Peakon as an Administrator.

  2. In the menu bar on the left side of the page, click Configuration, then navigate to Integrations.

    Screenshot shows the Configuration

  3. On Integrations page, click on Single Sign-On.

    Screenshot shows the Single

  4. Under Single Sign-On section, click on Enable.

    Screenshot shows to enable Single Sign-On

  5. On the Single sign-on for employees using SAML section, perform the following steps:

    Screenshot shows SAML Single sign-on

    a. In the SSO Login URL textbox, paste the value of Login URL, which you copied previously.

    b. In the SSO Logout URL textbox, paste the value of Logout URL, which you copied previously.

    c. Click Choose file to upload the certificate that you have downloaded, into the Certificate box.

    d. Click the icon to copy the Entity ID and paste in Identifier textbox in Basic SAML Configuration section.

    e. Click the icon to copy the Reply URL (ACS) and paste in Reply URL textbox in Basic SAML Configuration section.

    f. Click Save.

Create Peakon test user

For enabling Microsoft Entra users to sign in to Peakon, they must be provisioned into Peakon.
In the case of Peakon, provisioning is a manual task.

To provision a user account, perform the following steps:

  1. Sign in to your Peakon company site as an administrator.

  2. In the menu bar on the left side of the page, click Configuration, then navigate to Employees.

    Screenshot shows the employee

  3. On the top right side of the page, click Add employee.

    Screenshot shows to add employee

  4. On the New employee dialog page, perform the following steps:

    Screenshot shows the new employee

    1. In the Name textbox, type first name as Britta and last name as simon.

    2. In the Email textbox, type the email address like Brittasimon@contoso.com.

    3. Click Create employee.

Test SSO

In this section, you test your Microsoft Entra single sign-on configuration with following options.

SP initiated:

  • Click on Test this application, this will redirect to Peakon Sign on URL where you can initiate the login flow.

  • Go to Peakon Sign-on URL directly and initiate the login flow from there.

IDP initiated:

  • Click on Test this application, and you should be automatically signed in to the Peakon for which you set up the SSO.

You can also use Microsoft My Apps to test the application in any mode. When you click the Peakon tile in the My Apps, if configured in SP mode you would be redirected to the application sign on page for initiating the login flow and if configured in IDP mode, you should be automatically signed in to the Peakon for which you set up the SSO. For more information, see Microsoft Entra My Apps.

Next steps

Once you configure FreshDesk you can enforce session control, which protects exfiltration and infiltration of your organization’s sensitive data in real time. Session control extends from Conditional Access. Learn how to enforce session control with Microsoft Cloud App Security.