Difference between revisions of "PEC-GPA/Current/Administrator/GPlusSSO90"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2")
(Published)
Line 6: Line 6:
 
|ComingSoon=No
 
|ComingSoon=No
 
|Platform=GenesysEngage-cloud
 
|Platform=GenesysEngage-cloud
−
|Prereq=
 
 
|Section={{Section
 
|Section={{Section
−
|sectionHeading=
 
−
|anchor=
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
+
|structuredtext=You can configure Gplus Adapter to use either your own IDP or Salesforce as an IDP. You can choose one of these two options:
−
|image=
+
<ol>
−
|structuredtext=You can configure Gplus Adapter to use either your own IDP or Salesforce as an IDP. You can choose one of these two options:<ol><li>'''Gplus Adapter configured with SSO and your own Identity Provider (IDP)'''.<ul><li>Ensure that SSO for Agent Desktop release 9 has been enabled in your environment by following the instructions in the {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Single_Sign-On|display text=Agent Setup SSO article}} and the {{Link-AnywhereElse|product=PEC-Admin|version=Current|manual=Admin|topic=SSO|display text=Single Sign-On article}}.</li>
+
<li><p>'''Gplus Adapter configured with SSO and {{Link-SomewhereInThisVersion|manual=Administrator|topic=GPlusSSO90|anchor=OwnIDP|display text=your own Identity Provider (IDP)}}'''.</p>
−
<li>To ensure that your IDP page is not blocked by the browser and successfully opens in the Gplus Adapter iframe, verify your IDP response headers configuration:
+
<li>
 +
<p>'''Gplus Adapter integrated with {{Link-SomewhereInThisVersion|manual=Administrator|topic=GPlusSSO90|anchor=SFSSO|display text=Salesforce SSO as the IDP}}'''.</p>
 +
<p>This option provides an improved experience over the first option.</p>
 +
</li>
 +
</ol><br />
 +
|Status=No
 +
}}{{Section
 +
|sectionHeading=Gplus Adapter configured with SSO and your own IDP
 +
|anchor=OwnIDP
 +
|alignment=Vertical
 +
|structuredtext=To configure Gplus Adapter with SSO and your own Identity Provider (IDP), perform the following steps:
 +
<ul><li><p>Ensure that SSO for Agent Desktop release 9 has been enabled in your environment by following the instructions in the {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Single_Sign-On|display text=Agent Setup SSO article}} and the {{Link-AnywhereElse|product=PEC-Admin|version=Current|manual=Admin|topic=SSO|display text=Single Sign-On article}}.</p></li><li><p>To ensure that your IDP page is not blocked by the browser and successfully opens in the Gplus Adapter iframe, verify your IDP response headers configuration:
 +
 
 
<ul>
 
<ul>
−
<li>For the Chrome, Firefox, and Microsoft Edge browsers:  
+
<li>
−
<br />
+
<p>For the Chrome, Firefox, and Microsoft Edge browsers:</p><p>If the IDP server response contains the obsolete '''X-Frame-Options''' header, consider replacing it with the '''Content-Security-Policy''' header setting.</p>
−
If the IDP server response contains the obsolete '''X-Frame-Options''' header, consider replacing it with the '''Content-Security-Policy''' header setting.
+
<p>For example (Lightning):</p>
−
<br />
 
−
For example:
 
−
<br />
 
 
<BLOCKQUOTE>Content-Security-Policy: frame-ancestors 'self' <nowiki>https://*.genesyscloud.com https://*.lightning.force.com;</nowiki></BLOCKQUOTE>
 
<BLOCKQUOTE>Content-Security-Policy: frame-ancestors 'self' <nowiki>https://*.genesyscloud.com https://*.lightning.force.com;</nowiki></BLOCKQUOTE>
 +
<p>For example (Classic):</p>
 +
<BLOCKQUOTE>Content-Security-Policy: frame-ancestors 'self' <nowiki>https://*.genesyscloud.com https://*.slaesforce.com;</nowiki></BLOCKQUOTE>
 
</li>
 
</li>
−
<li>For the Internet Explorer 11:
+
<li><p>For the Internet Explorer 11 browser:</p>
−
<br />
+
<p>If IDP server response contains '''X-Frame-Options''' header, add '''ALLOW-FROM URI''' to the header setting.</p><p>For example (Lightning):</p>
−
If IDP server response contains '''X-Frame-Options''' header, add '''ALLOW-FROM URI''' to the header setting.
 
−
<br />
 
−
For example:
 
−
<br />
 
 
<BLOCKQUOTE>X-Frame-Options: ALLOW-FROM <nowiki>https://<your-server-name>.genesyscloud.com/ https://<your-server-name>.lightning.force.com/;</nowiki></BLOCKQUOTE>
 
<BLOCKQUOTE>X-Frame-Options: ALLOW-FROM <nowiki>https://<your-server-name>.genesyscloud.com/ https://<your-server-name>.lightning.force.com/;</nowiki></BLOCKQUOTE>
 +
<p>For example (Classic):</p>
 +
<BLOCKQUOTE>X-Frame-Options: ALLOW-FROM <nowiki>https://<your-server-name>.genesyscloud.com/ https://<your-server-name>.salesforce.com/;</nowiki></BLOCKQUOTE>
 +
</li>
 +
</ul>
 +
<p>For more information about Gplus Adapter configuration for IDP, see this [https://help.salesforce.com/articleView?id=000354489&language=en_US&type=1&mode=1 Salesforce Knowledge Article].</p>
 +
</li>
 +
{{AnchorDiv|SameSite}}
 +
<li>
 +
<p>Gplus Adapter follows the security rules for iFrame embedded applications in Chrome, Firefox, and Microsoft Edge browsers, if the '''SameSite by default cookies''' flag in the agent's browser is enabled by default or by the agent and the IDP provider did not set '''SameSite=None''' for cookies, the agent's IDP login page might get blocked by the browser.</p>
 +
<p>To solve this problem, you must reconfigure the IDP responses so that the '''SameSite=None''' cookie is present in the IDP response.</p>
 +
<p>If you have your agents' browser configured to treat cookies as '''''SameSite=Lax''''' by default, then you likely also have the '''Cookie without SameSite must be secure''' rule enabled as well. In this case, the cookie from the same IDP must have the '''Secure''' flag set.</p>
 +
<p>For more information about configuring browser security settings, refer to the documentation for the browsers used by your organization.</p>
 +
</li>
 +
<li>
 +
<p>For SSO logout configuration, use the following Agent Setup Desktop {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Global_Login|display text=Global Login}} options:
 +
<ul>
 +
<li>
 +
<p>'''Invalidate Auth SSO session on Workspace logout'''</p>
 +
</li>
 +
<li>
 +
<p>'''Show Change Account Link'''</p>
 
</li>
 
</li>
 
</ul>
 
</ul>
 +
</p>
 
</li>
 
</li>
−
<li>For SSO logout configuration, use the following Agent Setup Desktop {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Global_Login|display text=Global Login}} options:<ul><li>'''Invalidate Auth SSO session on Workspace logout'''</li><li>'''Show Change Account Link'''</li></ul></li><li>Adapter is now ready to use with SSO.</li></ul></li><li>'''Gplus Adapter integrated with {{Link-SomewhereInThisVersion|manual=Administrator|topic=GPlusSSO90|anchor=SFSSO|display text=Salesforce SSO as the IDP}}'''.
+
<li><p>Adapter is now ready to use with SSO.</p></li></ul>
−
This option provides an improved experience over the first option.
 
−
</li></ol>
 
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 44: Line 66:
 
|anchor=SFSSO
 
|anchor=SFSSO
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
 
−
|image=
 
 
|structuredtext=You can simplify your agent log in process by integrating Gplus Adapter with Salesforce to use Salesforce as your single sign-on (SSO) identity provider (IDP). This means that your agent only has to provide their Username and Tenant to log in to Gplus Adapter after they have logged into Salesforce using Salesforce as your SSO identity provider.
 
|structuredtext=You can simplify your agent log in process by integrating Gplus Adapter with Salesforce to use Salesforce as your single sign-on (SSO) identity provider (IDP). This means that your agent only has to provide their Username and Tenant to log in to Gplus Adapter after they have logged into Salesforce using Salesforce as your SSO identity provider.
  
Line 52: Line 72:
 
#{{Link-SomewhereInThisManual|topic=GPlusSSO90|anchor=IDP|display text=Enable Salesforce as an Identity Provider}}
 
#{{Link-SomewhereInThisManual|topic=GPlusSSO90|anchor=IDP|display text=Enable Salesforce as an Identity Provider}}
 
#{{Link-SomewhereInThisManual|topic=GPlusSSO90|anchor=ConnectedApp|display text=Define Gplus Adapter as a Connected App in Salesforce}}
 
#{{Link-SomewhereInThisManual|topic=GPlusSSO90|anchor=ConnectedApp|display text=Define Gplus Adapter as a Connected App in Salesforce}}
−
<!--
+
<!--{{NoteFormat|SSO is applicable to both test and production environments. Genesys recommends that you test SSO in your testing environment before using it in a production environment.|1}}-->
−
{{NoteFormat|SSO is applicable to both test and production environments. Genesys recommends that you test SSO in your testing environment before using it in a production environment.|1}}-->
 
  
 
===Enable Salesforce as an Identity Provider===
 
===Enable Salesforce as an Identity Provider===
Line 61: Line 80:
 
*User email address (username) that you use to login to Salesforce. '''Note:''' Username email addresses must be the same in both Salesforce and Gplus Adapter.
 
*User email address (username) that you use to login to Salesforce. '''Note:''' Username email addresses must be the same in both Salesforce and Gplus Adapter.
 
{{AnchorDiv|IDP}}
 
{{AnchorDiv|IDP}}
−
 
 
====Enable Salesforce as an Identity Provider====
 
====Enable Salesforce as an Identity Provider====
 
<ol>
 
<ol>
Line 80: Line 98:
 
</ol>
 
</ol>
 
{{AnchorDiv|ConnectedApp}}
 
{{AnchorDiv|ConnectedApp}}
−
 
 
===Define Gplus Adapter as a Connected App in Salesforce===
 
===Define Gplus Adapter as a Connected App in Salesforce===
 
<ol>
 
<ol>
Line 96: Line 113:
 
<li>Entity ID: The long string of numbers and letters at the end of the '''Location''' parameter URL after the last "/". </li>
 
<li>Entity ID: The long string of numbers and letters at the end of the '''Location''' parameter URL after the last "/". </li>
 
<li>ACS URL: The URL from the '''Location''' parameter that you obtained from the SP-Metadata in step 2 of the ''Enable SSO on Genesys tenants'' procedure.</li>
 
<li>ACS URL: The URL from the '''Location''' parameter that you obtained from the SP-Metadata in step 2 of the ''Enable SSO on Genesys tenants'' procedure.</li>
 +
<p>For example (Lightning):</p>
 +
<p>[[File:Gplus_900_Salesforce_Setup_New_Connected_App_View.png|500px]]</p>
 +
<p>For example (Classic):</p>
 +
<p>[[File:Gplus_900_Salesforce_Setup_New_Connected_App_View_Classic.png|500px]]</p>
 
</ul>
 
</ul>
−
[[File:Gplus_900_Salesforce_Setup_New_Connected_App_View.png|500px]]
 
 
</li>
 
</li>
 
<li>Use the [https://help.salesforce.com/articleView?id=identity_provider_error_log.htm&type=5 identity provider event log] to troubleshoot errors when trying to log in to Gplus Adapter.</li>
 
<li>Use the [https://help.salesforce.com/articleView?id=identity_provider_error_log.htm&type=5 identity provider event log] to troubleshoot errors when trying to log in to Gplus Adapter.</li>
Line 117: Line 137:
 
*[http://salesforce.vidyard.com/watch/I6j0O6jqr8ZTtoj5Wm_Fjg Video example from Salesforce]
 
*[http://salesforce.vidyard.com/watch/I6j0O6jqr8ZTtoj5Wm_Fjg Video example from Salesforce]
 
<!--* [https://help.mypurecloud.com/articles/about-single-sign-on-sso/ Example of the same SSO implementation in Genesys Cloud]-->
 
<!--* [https://help.mypurecloud.com/articles/about-single-sign-on-sso/ Example of the same SSO implementation in Genesys Cloud]-->
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 18:37, September 17, 2020

This topic is part of the manual Gplus Adapter for Salesforce Administrator's Guide for version Current of Gplus Adapter for Salesforce.

You can configure Gplus Adapter to use either your own IDP or Salesforce as an IDP.

You can configure Gplus Adapter to use either your own IDP or Salesforce as an IDP. You can choose one of these two options:

  1. Gplus Adapter configured with SSO and your own Identity Provider (IDP).

  2. Gplus Adapter integrated with Salesforce SSO as the IDP.

    This option provides an improved experience over the first option.


Gplus Adapter configured with SSO and your own IDP

To configure Gplus Adapter with SSO and your own Identity Provider (IDP), perform the following steps:

  • Ensure that SSO for Agent Desktop release 9 has been enabled in your environment by following the instructions in the Agent Setup SSO article and the Single Sign-On article.

  • To ensure that your IDP page is not blocked by the browser and successfully opens in the Gplus Adapter iframe, verify your IDP response headers configuration:

    • For the Chrome, Firefox, and Microsoft Edge browsers:

      If the IDP server response contains the obsolete X-Frame-Options header, consider replacing it with the Content-Security-Policy header setting.

      For example (Lightning):

      Content-Security-Policy: frame-ancestors 'self' https://*.genesyscloud.com https://*.lightning.force.com;

      For example (Classic):

      Content-Security-Policy: frame-ancestors 'self' https://*.genesyscloud.com https://*.slaesforce.com;

    • For the Internet Explorer 11 browser:

      If IDP server response contains X-Frame-Options header, add ALLOW-FROM URI to the header setting.

      For example (Lightning):

      X-Frame-Options: ALLOW-FROM https://<your-server-name>.genesyscloud.com/ https://<your-server-name>.lightning.force.com/;

      For example (Classic):

      X-Frame-Options: ALLOW-FROM https://<your-server-name>.genesyscloud.com/ https://<your-server-name>.salesforce.com/;

    For more information about Gplus Adapter configuration for IDP, see this Salesforce Knowledge Article.

  • Gplus Adapter follows the security rules for iFrame embedded applications in Chrome, Firefox, and Microsoft Edge browsers, if the SameSite by default cookies flag in the agent's browser is enabled by default or by the agent and the IDP provider did not set SameSite=None for cookies, the agent's IDP login page might get blocked by the browser.

    To solve this problem, you must reconfigure the IDP responses so that the SameSite=None cookie is present in the IDP response.

    If you have your agents' browser configured to treat cookies as SameSite=Lax by default, then you likely also have the Cookie without SameSite must be secure rule enabled as well. In this case, the cookie from the same IDP must have the Secure flag set.

    For more information about configuring browser security settings, refer to the documentation for the browsers used by your organization.

  • For SSO logout configuration, use the following Agent Setup Desktop Global Login options:

    • Invalidate Auth SSO session on Workspace logout

    • Show Change Account Link

  • Adapter is now ready to use with SSO.

Salesforce as SSO and IDP

You can simplify your agent log in process by integrating Gplus Adapter with Salesforce to use Salesforce as your single sign-on (SSO) identity provider (IDP). This means that your agent only has to provide their Username and Tenant to log in to Gplus Adapter after they have logged into Salesforce using Salesforce as your SSO identity provider.

Follow these steps to set up SSO with Salesforce as the identity provider:

  1. Enable Salesforce as an Identity Provider
  2. Define Gplus Adapter as a Connected App in Salesforce

Enable Salesforce as an Identity Provider

Prerequisites

  • You must have an Admin role in your organization's Salesforce account
  • User email address (username) that you use to login to Salesforce. Note: Username email addresses must be the same in both Salesforce and Gplus Adapter.

Enable Salesforce as an Identity Provider

  1. Follow the steps in the Enable Salesforce as an Identity Provider article in the Salesforce Help.
  2. In the Identity Provider view, click Download Metadata to obtain a copy of the IDP metadata XML.

Enable SSO on Genesys tenants

  1. Employing SAML for SSO requires two parts, a Service Provider (Genesys Auth Service) and an Identity Provider (Salesforce). To complete your Service Provider configuration, you must upload the Salesforce Identity Provider IDP-metadata XML file you created in the previous procedure to Agent Setup (refer to the Agent Setup SSO article).
  2. Download and open the SP-Metadata XML file in an XML viewer and find the Location parameter. You will need this parameter for the Entity ID and the ACS URL when you define Gplus Adapter as a Connected App in Salesforce. The Location URL looks something like this: https://gws-usw1.genhtcc.com/auth/v3/saml/SSO/alias/<string representing the Entity ID>.
  3. For SSO logout configuration, use the following Agent Setup Desktop Global Login options:
    • Invalidate Auth SSO session on Workspace logout
    • Show Change Account Link

Define Gplus Adapter as a Connected App in Salesforce

  1. To configure a new Connected App follow the instructions in the Salesforce Help Defining Service Providers as SAML-Enabled Connected Apps document.
  2. Specify the required fields under Basic Information:
    • Connected App Name (for example, Gplus Adapter)
    • API Name (for example, GWS)
    • Contact email (the email address of the Admin user)
  3. Under Web App Settings, select Enable SAML
  4. Use the Location string from the SP-Metadata xml file of the Enable Salesforce as an Identity Provider procedure to provide Entity ID and ACS URL:
    • Entity ID: The long string of numbers and letters at the end of the Location parameter URL after the last "/".
    • ACS URL: The URL from the Location parameter that you obtained from the SP-Metadata in step 2 of the Enable SSO on Genesys tenants procedure.

      • For example (Lightning):

      Gplus 900 Salesforce Setup New Connected App View.png

      For example (Classic):

      Gplus 900 Salesforce Setup New Connected App View Classic.png

  5. Use the identity provider event log to troubleshoot errors when trying to log in to Gplus Adapter.

Agent SSO login workflow

This is the general workflow when Gplus Adapter initiates the login process and uses Salesforce to identify the user:

  1. An agent logs in to Salesforce.
  2. The agent provides their Username and Tenant name in Gplus Adapter and clicks Next.
  3. GPlus Adapter sends a request to Salesforce to authenticate the user.
  4. Salesforce identifies the agent specified in the request and sends an authentication response.
  5. Gplus Adapter authenticates the response sent by Salesforce.
  6. If the agent is authenticated, they are logged in to Gplus Adapter while logged in to Salesforce.

Useful links

Retrieved from "https://all.docs.genesys.com/PEC-GPA/Current/Administrator/GPlusSSO90 (2024-05-02 12:15:49)"
Comments or questions about this documentation? Contact us for support!