Adding Your Identity Provider to CxEngage

After you've added as a service provider to your SAML provider, you're ready to add an identity provider to CxEngage:

  1. In the configuration interface, go to Configuration > Identity Providers.
  2. Click Create.
  3. Enter the identity provider details:
    • Name: A display name for the identity provider.
    • Description: Optionally, a description of the identity provider.
    • Type: Select a method for retrieving your metadata file: 
      • URL: The URL to your metadata file. This is the preferred method if your identity provider isn't behind a firewall.
      • XML File: Upload the XML metadata file.
      • XML Direct Input: Enter the XML from your metadata file in a text box.
      • Shared Access Code: Enter the Shared Identity Provider ID from another identity provider set up in CxEngage to share the configuration.
    • Configuration: Enter the details based on the type selected:
      TypeConfiguration Fields
      URL

      Email Mapping: The field in the SAML assertion that is mapped to the email address of the user. If not specified, the default value is Email.

      Metadata URL: A URL that points to a metadata.xml file on the tenant's SAML server.

       URL is the preferred type to use if your identity provider isn't behind a firewall. If the metadata file is updated on your server, the configuration in CxEngage updates as well.
      XML File

      Email Mapping: The field in the SAML assertion that is mapped to the email address of the user. If not specified, the default value is Email.

      Upload XML Config: Click the upload icon () to upload the metadata file for the tenant's SAML server.

       

      The XML is validated when you click Submit. If it isn't valid, an error message is presented.

      If you receive this message, make any necessary changes to your XML, upload the file with the changes, and click Submit again.

      XML Direct Input

      Enter XML Markup Here: Enter the contents of the tenant's metadata file in XML.

       

      The XML is validated when you click Submit. If it isn't valid, an error message is presented.

      If you receive this message, make any necessary changes to your XML and click Submit again.

      Shared Access Code

      Access Code: After an Identity Provider is created in CxEngage, a code is generated so that you can reuse the same Identity Provider in other tenants.

      If you want to reuse an Identity Provider in another tenant, locate its access code under Shared Identity Provider ID in its configuration details.

  4. Click Submit.

    A Shared Identity Provider ID is generated and listed in the configuration panel. Use this code when you want to reuse this identity provider's configuration in another tenant.

  5. Click the toggle at the top of the panel to enable the identity provider.

    If you want to disable the identity provider in the future, there can't be any users logged into CxEngage using that identity provider at that time. You can only disable the identity provider when all users that log in using that identity provider are logged out of CxEngage.

Now that you've created an identity provider in CxEngage, you can set your Platform Authentication settings and select a default Single Sign On Identity provider for your tenant. See Setting a Default Single Sign On Identity Provider for more information.

You might also be interested in: