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.



    Note:
    • All users even SSO only users are required to complete the 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 the user 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 Admin in the CloudLink Portal they will always be offered the option to sign in using the Mitel credentials in addition to the single sign-on option.

  3. Add the CloudLink Platform information into the IdP.
    While configuring the SAML application in the IdP portal, enter the following information about the CloudLink Platform into the IdP portal.
    • Service Provider Entity ID field: 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.
  4. Add the IdP portal information into Mitel Administration.
    Once you have entered the above mentioned information into the IdP portal, the IdP portal should provide you with the same two pieces of information as above, except on the IdP side of the connection.
    • 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.
    • 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.
  5. Upload the IdP certificate to Mitel Administration.
    To do this, from the IdP portal, download the public certificate X.509 certificate in PEM format provided by IdP and save it on your computer. After saving the certificate, open the certificate file in a text editor, copy all data in the file, and then paste the data into the Signing Certificate field in the Mitel Administration.
    Note: If you have more than one certificate, it is recommended that you paste them one after the other.
  6. Once you have entered the three IdP fields and have uploaded the IdP certificate into Mitel Administration, click Save to save the SSO settings.

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.