From Bright Pattern Documentation
Jump to: navigation, search
(Updated via BpClonePage extension. Source page: draft:Saml2-single-sign-on-integration-guide/AddSSOtoBrightPattern)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<translate>= Add SSO to Bright Pattern =
+
= Add SSO to Bright Pattern =
Now that you've created a G Suite app and copied the link to it, you're ready to enable SSO in Bright Pattern.
+
The following guide assumes you have [[Saml2-single-sign-on-integration-guide/GSuiteSSOConfiguration|configured a G Suite SSO app]], and have access to the ''Single Sign-On URL'' and ''Certificate'' generated while configuring the app.  
  
Single sign-on integration configuration is completed in Bright Pattern’s Service Provider application and the Contact Center Administrator application, and it’s tested in the Agent Desktop application.
+
The steps below describe how to configure the single sign-on integration in Bright Pattern’s Administrator application.  
  
 
== Bright Pattern Applications ==
 
== Bright Pattern Applications ==
The Service Provider application (i.e., “https://<tenant>.brightpattern.com/sysmgmt”) is where Bright Pattern Contact Center-based solutions are configured and managed at the service provider level. For more information, see the [[service-provider-guide/LoginProcedure|Service Provider Guide]].
 
 
 
The Contact Center Administrator application (i.e., “https://<tenant>.brightpattern.com/admin”) is where contact center resources are configured and managed at the system administrator level. For more information, see the [[contact-center-administrator-guide/LoginProcedure|Contact Center Administrator Guide]].
 
The Contact Center Administrator application (i.e., “https://<tenant>.brightpattern.com/admin”) is where contact center resources are configured and managed at the system administrator level. For more information, see the [[contact-center-administrator-guide/LoginProcedure|Contact Center Administrator Guide]].
  
Line 12: Line 10:
  
 
== Procedure ==
 
== Procedure ==
=== Step 1: Enable SSO feature in Service Provider application ===
+
=== Step 1: Ask your Service Provider to enable the SSO integration for your Contact Center ===
By default, SSO functionality is disabled. Enable it by following these steps:<br /><br />
+
Ensure your service provider has enabled SSO for your contact center before continuing.<br />
# In the Service Provider application, go to ''Tenants'' and select the name of your contact center from the list.<br /><br />
 
# Click the '''Features''' tab.<br /><br />
 
# In the list of features to enable or allow, select the checkbox for '''Enable Single Sign-On'''.<br /><br />
 
# Click '''Apply'''.
 
  
 
=== Step 2: Create SSO integration account in Contact Center Administrator ===
 
=== Step 2: Create SSO integration account in Contact Center Administrator ===
Line 25: Line 19:
 
# Select account type '''Single Sign-On'''.<br /><br />
 
# Select account type '''Single Sign-On'''.<br /><br />
 
# Name the account (e.g., “G Suite”).<br /><br />
 
# Name the account (e.g., “G Suite”).<br /><br />
# In the ''Agent Desktop SSO'' section, select the checkbox for '''Enable Single Sign-On'''.<br /><br />
+
# Select the checkbox for '''Enable Single Sign-On'''. <br /><br />
# Paste your copied data into '''Identity Provider Single Sign-On URL''' (the link will look like this):
+
# Optionally, select the checkbox '''Use SSO for administrator portal login'''.
 
+
#*When selected, SSO will be used to authenticate users of ''both'' the Agent Desktop and the Administrator Portal.
 
+
#*When not selected, SSO will only be used to authenticate Agent Desktop users, while Administrator Portal users will login with their BPCC credentials.<br /><br />
https://accounts.google.com/o/saml2/initsso?idpid=C00xdeh6y&spid=551268412404&forceauthn=false)
+
# Paste your copied data into '''Identity Provider Single Sign-On URL''' (the link will look like this):<br /><br /><code>https://accounts.google.com/o/saml2/initsso?idpid=C00xdeh6y&spid=551268412404&forceauthn=false)</code><br /><br />
 +
# Enter the '''Identity Provider Single Sign-On Logout URL''' for Google:<br /><br /><code>https://accounts.google.com/logout</code><br /><br />
  
 
=== Step 3: Add remaining properties ===
 
=== Step 3: Add remaining properties ===
Line 62: Line 57:
 
# Enter credentials from your G Suite account.<br /><br />
 
# Enter credentials from your G Suite account.<br /><br />
 
# The system will then redirect you to Agent Desktop as the logged-in user.
 
# The system will then redirect you to Agent Desktop as the logged-in user.
 
 
 
 
</translate>
 

Latest revision as of 04:55, 7 March 2025

• 5.19 • 5.3 • 5.8

Add SSO to Bright Pattern

The following guide assumes you have configured a G Suite SSO app, and have access to the Single Sign-On URL and Certificate generated while configuring the app.

The steps below describe how to configure the single sign-on integration in Bright Pattern’s Administrator application.

Bright Pattern Applications

The Contact Center Administrator application (i.e., “https://<tenant>.brightpattern.com/admin”) is where contact center resources are configured and managed at the system administrator level. For more information, see the Contact Center Administrator Guide.

The Agent Desktop application (i.e., “https://<tenant>.brightpattern.com/agentdesktop”) is where contact center agents and supervisors interact with customers and other users. For more information, see the Agent Guide.

Procedure

Step 1: Ask your Service Provider to enable the SSO integration for your Contact Center

Ensure your service provider has enabled SSO for your contact center before continuing.

Step 2: Create SSO integration account in Contact Center Administrator

For SSO to work, you must also enable it for your contact center in SSO integration account properties.

  1. In the Contact Center Administrator application, go to Call Center Configuration > Integration Account.

  2. Click the Add account button (+) to create a new integration account.

  3. Select account type Single Sign-On.

  4. Name the account (e.g., “G Suite”).

  5. Select the checkbox for Enable Single Sign-On.

  6. Optionally, select the checkbox Use SSO for administrator portal login.
    • When selected, SSO will be used to authenticate users of both the Agent Desktop and the Administrator Portal.
    • When not selected, SSO will only be used to authenticate Agent Desktop users, while Administrator Portal users will login with their BPCC credentials.

  7. Paste your copied data into Identity Provider Single Sign-On URL (the link will look like this):

    https://accounts.google.com/o/saml2/initsso?idpid=C00xdeh6y&spid=551268412404&forceauthn=false)

  8. Enter the Identity Provider Single Sign-On Logout URL for Google:

    https://accounts.google.com/logout

Step 3: Add remaining properties

  1. Add your other G Suite info (note that Identity Provider Issuer is not mandatory).

Step 4: Edit certificate

Open the certificate that you downloaded in Notepad++ or a similar text editor.

In the certificate, before content begins, insert the following:

"-----BEGIN CERTIFICATE-----"

At the end of the content, insert the following:

"-----END CERTIFICATE----- "

Step 5: Add certificate

  1. Back in Contact Center Administrator, beside Identity Provider Certificate, hover your cursor over “empty” and click EDIT.

  2. In the dialog that pops up, paste your certificate (with "begin certificate" and "end certificate" sections) to the certificate option.

  3. Click Apply to save your changes.

Step 6: Create a user

Before you can test that SSO works, you will need to create a dummy user.

  1. In the Contact Center Administrator application, go to Users & Teams > Users.

  2. Click the Add user button to create a new user.

  3. Set the username as “user1” and specify the desired password.

  4. Click Apply to save your changes.

Step 7: Test SSO in Agent Desktop

You can try logging in to Agent Desktop with the username and password you just created.

  1. Go to the Agent Desktop application (e.g., https://<bp hostname>/agentdesktop/).

  2. The login page should redirect you to the ForgeRock login page.

  3. Enter credentials from your G Suite account.

  4. The system will then redirect you to Agent Desktop as the logged-in user.
    < Previous | Next >