How to Integrate PingID SSO With BarTender Cloud
Overview
As of the 11.2 BarTender Cloud update, you can now use Ping Identity (PingID) SSO to sign in to BarTender Cloud.
This article will show you how to configure your PingID application and BarTender Cloud tenant to facilitate proper integration and get things running smoothly.
Applicable to
BarTender Cloud
Information
Creating a Ping ID Sample Application
We'll start by creating a sample app from scratch to demonstrate which parameters you must configure in your Ping ID app to integrate it with BarTender Cloud. You can absolutely use an existing PingID app with BarTender Cloud, as long as the end conditions below match.
- Starting in the Ping ID Environment of your choice, select the Applications tab on the left-hand side and click the + icon to create a new app.
- Enter a name for your app. A description is optional. Set OIDC Web App as the Application Type and click Save.
- Select the Resources tab in your newly created app and click the Edit icon.
- Check the boxes next to email and profile, then click Save. These parameters, along with openid, should now appear under Allowed Scopes.
- Next, select the Configuration tab and click the Edit icon.
- Use the dropdown menu to change the Token Endpoint Authentication Method to Client Secret Post.
- Enter your Redirect URI. This will be different for each individual, but will always end with the suffix /signin-callback-pingid. You can find the first part on the Login page for your BarTender Cloud tenant. For the Login page in the screenshot below, the full Redirect URI would be:
https://auth.am1.bartendercloud.com/signin-callback-pingid
- Enter your Signoff URL. The first part is identical to the Redirect URI (found on your specific BarTender Cloud Login page), but the suffix changes to /signout-callback-oidc. Once again, using the example in the screenshot above, the Signoff URL would be:
https://auth.am1.bartendercloud.com/signout-callback-oidc
- Click Save to complete your configuration.
- The last step is to turn your app on. To do so, click the toggle switch at the top left of the screen on any tab. It will turn blue if activation is successful.
Creating a PingID User
Before you can sign into BarTender Cloud using PingID for the first time, you must create a PingID User Profile to use when logging in.
- Go to Directory > Users on the left-hand side and click the + icon to add a new user.
- Fill out all fields and click Save. Remember your username and password, as you will use them to log into BarTender Cloud later.
Configuring Your BarTender Cloud Tenant
Next, we must set up your BarTender Cloud tenant to be able to communicate with your PingID app.
- Log in to BarTender Cloud. Go to Administration > Settings > Global Settings using the left-hand toolbar.
- Scroll down to the External Authentication Service section. Check the PingID box and use the arrow to expand that section. You'll notice fields for Client ID, Client Secret, and Issuer ID.
- These values are back in the Overview tab of your PingID app. We highly recommend that you use the indicated Copy button to record each value accurately.
- Post each one into the appropriate field in BarTender Cloud and click Save.
Enable Automatic Account Creation
If you check this box, you will be prompted to create a new BarTender Cloud user when you log into BarTender Cloud with a PingID user's username and password for the first time.
If you uncheck the box, you will instead be prompted to log in to BarTender Cloud using an already existing Cloud user's email and password. This will link the PingID user account and the existing Cloud account.
See the Logging Into BarTender Cloud Using PingID section below for further details.
Show BarTender Login/Password Fields
This checkbox enables the appearance of the Login and Password fields on the BarTender Login page. Unchecking this box will remove those fields, which you can only do if an external authentication service (such as PingID) is already configured.
Logging Into BarTender Cloud Using PingID
After you finished configuring PingID and your BarTender Cloud tenant, it's time to try logging in.
- Starting on the BarTender Cloud Login page, click Sign in using Ping Identity. This will bring up the Ping Identity Login dialog.
- Enter your PingID User Account's username and password (the one you created earlier), and click Sign On.
- You will need to change the original password you set before continuing. Click Save when you're finished. What happens next depends on whether you left Enable automatic account creation in your BarTender Cloud tenant checked.
With Enable Automatic Account Creation
If you left Enable automatic account creation checked, you will be directed to create a new BarTender Cloud User Account to associate with your PingID User Account.
- Fill out all required fields and click Next.
- Agree to the Terms of Service and click Finish. You will now be logged into this BarTender Cloud account every time you use these PingID credentials.
Without Enable Automatic Account Creation
If you unchecked Enable automatic account creation, you will be prompted to sign into the BarTender Cloud User Account that you want to associate with these PingID credentials.
- Click Continue Sign In. Enter your BarTender Cloud credentials and click Sign In. You will now be logged into this BarTender Cloud account every time you use these PingID credentials.
Troubleshooting
There are two common error messages. First, you might encounter this error when attempting to sign into BarTender Cloud using PingID. It indicates that the credentials you used are incorrect in some way. If you can't remember your password, click Forgot Password to receive a Password Reset email.
Second, the following is a general error that can indicate a wide variety of issues, including improper configuration on either the BarTender Cloud or PingID side or perhaps even an outage.
Please double-check that you followed all the configuration steps correctly and that all values are copied accurately into BarTender Cloud.
If you are unsure if you set things up properly, don't hesitate to contact Technical Support by clicking Contact Support and making a ticket.