Add OneLogin as a single sign-on provider

Automatic Logout of SSO provider: Feature coming soon

Prerequisites
  • Single Sign-on > Provider > Add, Delete, Edit, View permissions
  • Admin role in your organization’s OneLogin account
  • OneLogin Desktop SSO disabled
  • User email addresses are the same in both OneLogin and Genesys Cloud

Add Genesys Cloud as an application that organization members can access with the credentials to their OneLogin account.

Notes:
  • Genesys Cloud does not support assertion encryption for single sign-on third-party identity providers. The Genesys Cloud log in service requires Transport Layer Security (TLS). Since the channel is encrypted, there is no need to encrypt parts of the message.
  • Administrators can optionally disable the default Genesys Cloud login and enforce authentication using an SSO provider only. For more information, see Configure Genesys Cloud to authenticate with SSO only.
  • Administrators can choose to store one additional certificate to ensure business continuity. If one certificate becomes invalid or expires, the backup certificate will preserve the integration.

Configure OneLogin

Create a SAML application

  1. Add the OneLogin app called SAML Custom Connector (Advanced).
  2. In the app page, click the Configuration tab. 
  3. Complete the following fields. Leave the remaining fields blank.

    In this field… Do this…
    Audience (Entity ID)

    Type a value that will be used to identify your organization to the Identity Provider, i.e. “genesys.cloud.my-org”.

    ACS (Consumer) URL Validator

    Type the URL for the AWS region where your Genesys Cloud organization is located:

    US East (N. Virginia): ^https:\/\/login\.mypurecloud\.com\/saml
    US West (Oregon): ^https:\/\/login\.usw2\.pure\.cloud\/saml
    Canada (Canada Central): ^https:\/\/login\.cac1\.pure\.cloud\/saml
    EU (Frankfurt): ^https:\/\/login\.mypurecloud\.de\/saml
    EU (Ireland): ^https:\/\/login\.mypurecloud\.ie\/saml
    EU (London): ^https:\/\/login\.euw2\.pure\.cloud\/saml
    Asia Pacific (Mumbai): ^https:\/\/login\.aps1\.pure\.cloud\/saml
    Asia Pacific (Seoul): ^https:\/\/login\.apne2\.pure\.cloud\/saml
    Asia Pacific (Sydney): ^https:\/\/login\.mypurecloud\.com\.au\/saml
    Asia Pacific (Tokyo): ^https:\/\/login\.mypurecloud\.jp\/saml

    ACS (Consumer) URL

    Type the URL for the AWS region where your Genesys Cloud organization is located:
    US East (N. Virginia): https://login.mypurecloud.com/saml
    US West (Oregon): https://login.usw2.pure.cloud/saml
    Canada (Canada Central): https://login.cac1.pure.cloud/saml
    EU (Frankfurt): https://login.mypurecloud.de/saml
    EU (Ireland): https://login.mypurecloud.ie/saml
    EU (London): https://login.euw2.pure.cloud/saml
    Asia Pacific (Mumbai): https://login.aps1.pure.cloud/saml
    Asia Pacific (Seoul): https://login.apne2.pure.cloud/saml
    Asia Pacific (Sydney): 
    https://login.mypurecloud.com.au/saml
    Asia Pacific (Tokyo): https://login.mypurecloud.jp/saml

    Single Logout URL

    Type the URL for the AWS region where your Genesys Cloud organization is located:

    US East (N. Virginia): https://login.mypurecloud.com/saml/logout
    US West (Oregon): https://login.usw2.pure.cloud/saml/logout
    Canada (Canada Central): https://login.cac1.pure.cloud/saml/logout
    EU (Frankfurt): https://login.mypurecloud.de/saml/logout
    EU (Ireland): https://login.mypurecloud.ie/saml/logout
    EU (London): https://login.euw2.pure.cloud/saml/logout
    Asia Pacific (Mumbai): https://login.aps1.pure.cloud/saml/logout
    Asia Pacific (Seoul): https://login.apne2.pure.cloud/saml/logout
    Asia Pacific (Sydney): 
    https://login.mypurecloud.com.au/saml/logout
    Asia Pacific (Tokyo): https://login.mypurecloud.jp/saml/logout

    Sign SLO Request

    Check the box.

    Sign SLO Response

    Check the box.

  4. Click the Parameters tab.
  5. Click Add parameter.
  6. Complete the following fields. 
    In this field… Do this…
    Name Type OrganizationName.
    Flags Check Include in SAML assertion.
  7. Click Save.
  8. Click the newly-created OrganizationName parameter.
  9. In the Value field:
    1. From the list, select Macro.
    2. Type the short name of your Genesys Cloud organization. If you do not know the short name of your organization, click Admin > Account Settings > Organization Settings in Genesys Cloud. Complete the following fields. 
  10. Click Save.

SAML attributes

Genesys Cloud will act on the following additional SAML attributes if they are present in the assertion. The attributes are case-sensitive. 

Attribute name Attribute value
email  Email address of the Genesys Cloud user to be authenticated.
  • Must be an existing Genesys Cloud user.
  • Required if the identity provider does not use an email address as the subject NameID.
ServiceName 

(Optional). A valid URL for the browser to be redirected to after successful authentication, or one of the following keywords:

  • directory (redirects to the Genesys Cloud Collaborate client)
  • directory-admin (redirects to the Genesys Cloud Admin UI)

Get the certificate for the Genesys Cloud configuration

  1. Click the SSO tab.
  2. Under Certificate, click View Details.
  3. Under X.509 Certificate, select “X.509 PEM” and click Download.
  4. Save the certificate for later use.

Get the metadata for the Genesys Cloud configuration

Note: Genesys Cloud supports the http-redirect SAML URL only. The OneLogin SSO tab no longer shows this URL by default in the SAML 2.0 Endpoint (HTTP) field. (It now shows the http-post URL instead.) However, the http-redirect URL is still available in the SAML Metadata file.
  1. Click the SSO tab.
  2. Copy the following metadata that you need for the Genesys Cloud configuration to a text file. 
    Metadata Do this…
    Issuer URL Copy the URL from the Issuer URL field.
    SAML 2.0 Endpoint (HTTP)
    1. Under More Actions, click SAML Metadata.
    2. Download and open the SAML Metadata file.
    3. Find the SingleSignOnService tag with Binding equal to “urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect”, for example:  <SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://your-organization/onelogin.com/trust/saml2/http-redirect/sso/123456>
    4. Copy the URL following “Location =”, for example:
      https://your-organization/onelogin.com/trust/saml2/http-redirect/sso/123456
    SLO Endpoint (HTTP) Copy the URL from the SLO Endpoint (HTTP) field.

Configure Genesys Cloud

  1. In Genesys Cloud, click Admin.
  2. Under Integrations, click Single Sign-on.
  3. Click the OneLogin tab.
  4. Enter the information gathered in the previous procedure:

    In this field… Do this…
    Certificate
    1. Click Browse.
    2. Select the certificate you saved and click Open.
    3. Click Add .
    4. Optionally, to load a backup certificate, repeat steps 1-3. 
    OneLogin Issuer URI Type the URL from the Issuer URL field in OneLogin.
    Target URL

    Type the URL from the SAML 2.0 Endpoint (HTTP) field. 

    Single Logout URI

    Type the URL from the SLO Endpoint (HTTP) field in OneLogin.

    Single Logout Binding Select HTTP Redirect.
    Audience (Entity ID)  Type the OneLogin Audience (EntityID) value. This should be the same in Genesys Cloud and OneLogin.
  5. Click Save.