Configuring SAML Single Sign-On Integration for CloudLink with Identity Providers (generic instructions)

Following are instructions for setting up SAML Single Sign-On (SSO) integration using a generic identity provider. To configure SSO for CloudLink with Microsoft Azure AD, see Configuring Single Sign-On for CloudLink with Microsoft Azure AD.

Prerequisites

To configure SAML SSO integration with CloudLink platform, you must have:
  • An IdP subscription
  • Mitel CloudLink account

Procedure

Note: To configure SAML SSO integration, it is recommended that you open the IdP portal and the Mitel Administration side-by-side as you will need to copy some information from the Mitel Administration to the IdP portal and vice versa.
  1. Enable the Single Sign-On integration in the Mitel Administration.
    1. Navigate to the Account Information page of the customer account for which you want to enable the integration.
    2. In the Integrations section, click + Add new. A pop-up screen displays the Integrations panel.
    3. Click the 3rd party tab. A list of supported third-party applications is displayed. Click the Add button associated with Single Sign-On, and click Done.


      The Single Sign-On is enabled for the customer account and is added to the Integrations section of the Account Information page.

  2. Accessing the Single Sign-On configuration dialog box.

    In the Account Information page, click Complete setup.



    The Single Sign-On configuration dialog box opens.

  3. In Step 1 section, enter a name of your Identity Provider (IdP).
    Note: This is a free text field and can be customized based on your preferences.
  4. In Step 2 section, add the CloudLink Platform information to the IdP.
    • Service Provider Entity ID: Copy the ID from the Mitel Identifier (Entity ID) field in the Mitel Administration and paste it into the Entity ID field of the IdP portal.
    • Service Provider Login URL: Copy the URL from the Reply URL (Assertion Consumer Service URL) field in the Mitel Administration and paste it into the Login URL field of the IdP portal.
  5. In Step 3 section, add the IdP portal information into Mitel Administration.
    • IdP Login URL: Copy the URL from the Login URL field of the IdP portal and paste it into the Sign-in URL field in the Mitel Administration.
    • IdP Entity ID: Copy the ID from the entity ID field of the IdP portal and paste it into the IDP Identifier (Entity ID) field in the Mitel Administration.
    • Signing Certificate: Upload the IdP certificate to Mitel Administration.
      To do this:
      • From the IdP portal, download the public X.509 certificate in PEM format provided by the IdP and save it on your computer.
      • Open the certificate file in a text editor.
      • Copy all the contents of the file.
      • Paste the contents into the Signing Certificate field in Mitel Administration.

        If you have more than one certificate, it is recommended that you paste them one after the other.

  6. Click Save. Single sign-on (SSO) is enabled and allows users to sign in to Mitel applications using their enterprise username and password.
    Note:

    • All users, including SSO-only users, must complete the CloudLink welcome email process.

    • Mitel recommends that the Enable Mitel Credentials (Optional) check box in the Optional Mitel Credentials section is not selected. Select this check box only if you want users to log in to the CloudLink application using the Mitel credentials in addition to the single sign-on option.

    • If a CloudLink User is set as an Admin in the CloudLink Portal, they will always be offered the option to sign in using Mitel credentials in addition to the single sign-on option.

Renewing the SAML Signing Certificate

Renewing the SAML Signing Certificate updates the digital certificate used for secure communication in Single Sign-On (SSO) setups, ensuring continued security and validity.

Click here to learn more about how to renew the SAML signing certificate.

Removing Single Sign-On integration

To remove an existing Single Sign-On (SSO) integration from a customer account, follow these steps:
  1. Click Integrations & Apps. The Integrations and Applications page is displayed.

  2. Disable the Single Sign-On toggle to remove the SSO integration. The Remove integration? dialog box is displayed.

  3. Click Remove integration. The SSO integration will be removed from the Customer account.
    Note: Click the Settings icon next to Single Sign-On, and then click Remove to remove the SSO integration.
Parent topic: Integrating Single Sign-On with Mitel Administration
↑