Single Sign-On and Cisco Webex Teams

Single sign-on (SSO) is a session or user authentication process that permits a user to provide credentials to access one or more applications. The process authenticates users for all the applications that they are given rights to. It eliminates further prompts when users switch applications during a particular session.

The Security Assertion Markup Language (SAML 2.0) Federation Protocol is used to provide SSO authentication between the Cisco Webex cloud and your identity provider (IdP).

Profiles

Cisco Webex Teams only supports the web browser SSO profile. In the web browser SSO profile, Cisco Webex Teams supports the following bindings:

  • SP initiated POST -> POST binding

  • SP initiated REDIRECT -> POST binding

NameID Format

The SAML 2.0 Protocol supports several NameID formats for communicating about a specific user. Cisco Webex Teams supports the following NameID formats.

  • urn:oasis:names:tc:SAML:2.0:nameid-format:transient

  • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

  • urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

In the metadata that you load from your IdP, the first entry is configured for use in Cisco Webex.

SingleLogout

Cisco Webex Teams supports the single logout profile. In the Cisco Webex Teams app, a user can sign out of the application, which uses the SAML single logout protocol to end the session and confirm that sign out with your IdP. Ensure your IdP is configured for SingleLogout.

Integrate Cisco Webex Control Hub with PingFederate for Single Sign-On


The configuration guides show a specific example for SSO integration but do not provide exhaustive configuration for all possibilities. For example, the integration steps for nameid-format urn:oasis:names:tc:SAML:2.0:nameid-format:transient are documented. Other formats such as urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified or urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress will work for SSO integration but are outside the scope of our documentation.

Set up this integration for users in your Cisco Webex organization (including Cisco Webex Teams, Cisco Webex Meetings, and other services administered in Cisco Webex Control Hub). If your Webex site is integrated in Cisco Webex Control Hub, the Webex site inherits the user management. If you can't access Cisco Webex Meetings in this way and it is not managed in Cisco Webex Control Hub, you must do a separate integration to enable SSO for Cisco Webex Meetings. (See Configure Single Sign-On for Webex for more information in SSO integration in Site Administration.)

Before you begin

For SSO and Cisco Webex Control Hub, IdPs must conform to the SAML 2.0 specification. In addition, IdPs must be configured in the following manner:
  • Set the NameID Format attribute to urn:oasis:names:tc:SAML:2.0:nameid-format:transient

  • Configure a claim on the IdP to include the uid attribute name with a value that is mapped to the attribute that is chosen in Cisco Directory Connector or the user attribute that matches the one that is chosen in the Cisco Webex identity service. (This attribute could be E-mail-Addresses or User-Principal-Name, for example.) See the custom attribute information in https://www.cisco.com/go/hybrid-services-directory for guidance.

  • Use a supported browser: we recommend the latest version of Mozilla Firefox or Google Chrome.

  • Disable any popup blockers in your browser.

Download the Cisco Webex Metadata to your Local System

1

From the customer view in https://admin.webex.com, go to Settings, and then scroll to Authentication.

2

Click Modify, click Integrate a 3rd-party identity provider. (Advanced), and then click Next.

3

Download the metadata file.

The Cisco Webex metadata filename is idb-meta-<org-ID>-SP.xml.

Configure a New Service Provider Connection

1

Go to your PingFederate Administration portal (https://<FQDN of PingFederate>:9999/pingfederate/app).

2

Under SP CONNECTIONS, select Create New.

3

Select the Do not use a template for this connection radio button, then select Next.

4

Select Browser SSO Profiles, then click Next.

5

Select the Import Metadata tab.

6

Click Choose File to browse to and import the metadata file that you downloaded from Cisco Webex Control Hub, and then click Next.

7

Review the information in the General Info tab, and then click Done.

Configure Browser Single-Sign On

1

From the PingFederate Administration portal, select Configure Browser SSO.

2

Check the SP-Initiated SSO check box, then click Next.

3

Select Configure Assertion Creation.

  1. Change the NameID-format to Transient and check the Include attributes in addition to the transient identifier check box.

  2. Extend the contract attributes by adding mail and uid attributes in the format urn:oasis:names:tc:SAML:2.0:attrname-format-basic, then click Next.

  3. Select Map New Adapter Instance to pick an authentication mechanism. From the ADAPTER INSTANCE drop-down, select one of the previously configured authentication mechanisms, then click Next.

  4. Select the Retrieve additional attributes from multiple data stores using one mapping radio button, then click Next.

  5. Select Add Attribute Source to add the Active Directory Domain Controller for the domain, and then click Next.

  6. Specify the Base DN and select the root object class <Show All Attributes>. In the Filter text box, enter the LDAP filter, and then click Next.

    The entry must contain the attribute that you expect the user to provide. It also needs to contain the value that it maps to in the LDAP sources. For example, if your active directory is set to filter on the Windows login attribute, enter sAMAccountName=${Username}.

  7. Select the source and value to map the assertion attributes with the attributes provided by the AD datastore. (Don't enter anything for Issuance Criteria.)

  8. Verify that the Assertion Configuration has Identity Mapping set to Transient, Attribute Contract set to uid, and Adapter Instances set to 1.


     

    The uid attribute should map to the email address of the user.

4

Select Configure Protocol Settings.

  1. For Allowable SAML Bindings, check only the POST and Redirect checkboxes.

  2. For Signature Policy, select Always sign the SAML Assertion.

    The protocol settings should look like the following.

  3. Select Configure Credentials to configure the certificate for the assertion.

  4. Select the certificate that was already created for SAML assertions.

5

On the Activation and Summary screen, set the Connection Status to Active.

Export PingFederate Metadata

1

On the Main screen, click Manage All SP.

2

Find the connection that you just created and click Export Metadata.

3

Choose the certificate to use for signing the exported file from the drop-down.

4

Click Export.

Import the IdP Metadata and Enable Single Sign-On After a Test

After you export the Cisco Webex metadata, configure your IdP, and download the IdP metadata to your local system, you are ready to import it into your Cisco Webex organization from Control Hub.

Before you begin

Do not test SSO integration from the identity provider (IdP) interface. We only support Service Provider-initiated (SP-initiated) flows, so you must use the Control Hub SSO test for this integration.

1

Choose one:

  • Return to the Cisco Webex Control Hub – Export Directory Metadata page in your browser, and then click Next.
  • If Control Hub is no longer open in the browser tab, from the customer view in https://admin.webex.com, go to Settings, scroll to Authentication, choose Integrate a third-party identity provider (Advanced), and then click Next on trusted metadata file page (because you already did it before).
2

On the Import IdP Metadata page, either drag and drop the IdP metadata file onto the page or use the file browser option to locate and upload the metadata file. Click Next.

If the metadata isn't signed, is signed with a self-signed certificate, or is signed with a private enterprise certificate authority (CA), we recommend that you use require certificate signed by a certificate authority in Metadata (more secure). If the certificate is self-signed, you need to choose the less secure option.

3

Select Test SSO Connection, and when a new browser tab opens, authenticate with the IdP by signing in.


 

If you receive an authentication error there may be a problem with the credentials. Check the username and password and try again.

A Webex Teams error usually means an issue with the SSO setup. In this case, walk through the steps again, especially the steps where you copy and paste the Control Hub metadata into the IdP setup.

4

Return to the Control Hub browser tab.

  • If the test was successful, select This test was successful. Enable Single Sign-On option and click Next.
  • If the test was unsuccessful, select This test was unsuccessful. Disable Single Sign-On option and click Next.

What to do next

You can follow the procedure in Suppress Automated Emails to disable emails that are sent to new Webex Teams users in your organization. The document also contains best practices for sending out communications to users in your organization.