In this article, we'll go over the steps for setting up an Integrations Hub SSO with YourMembership.
1. Get Started with Integrations Hub.
2. Add a new SSO connector from the Integrations Hub dashboard.
3. You will be brought to a page with different SSO options. Select Yourmembership.
4. You will now be shown the below screen. Keep this screen open in your browser. We'll be jumping over to your YourMembership account to gather some credentials.
5. In a new browser tab, go to your YourMembership account URL:
https://{instanceurl}.site-ym.com/login.aspx
Example:
My organization is called King of The Hill and my website is KingoftheHill.com. This means my YourMembership account login link should be: https://KingoftheHill.site-ym.com/login.aspx
6. Request admin login credentials from your staff if you don't have them already (it's important that these credentials are admin, other account types will not have access to what we need). Once you have the proper credentials, login to YourMembership acocunt.
7. Now we're going to begin gathering a few items from within your organization's YourMembership account. We'll be copy/pasting these items into your Integration Hub settings so be sure to add these to a notepad as we go, for easy reference after:
Login URL
Base URL
App ID
App Secret
Site ID
Scopes
8. Now create a test account within your YourMembership admin account. We'll use this for setting up your field mapping in Integrations Hub as well as for testing once the SSO is built. Make sure you fill in all profile information for the test user that you'd expect a real user to have.
9. Jumping back to Integrations Hub in the browser tab you left open earlier, we're going to now add all of these data pieces from YourMembership to your Integrations Hub settings.
10. Let's begin by giving your connector a name. This name can be whatever you'd like but we normally suggest this format: {Name of Organization} SSO {Year}
11. You now copy/paste the Login URL you saved earlier in the field located under the Name.
12. Under the Login URL field, click "Select Credentials" then click "Add New Credentials" from the drop-down menu:
13. You should now have a half-window open up on the right side of your screen labeled "Create New Credentials". Add the remaining items we gathered from YourMemberhip:
14. Now click the "Add" button at the bottom of the "Create New Credentials" half-window. Click "save" at the top of left the connector settings.
15. Located under "Save" on the top left of your screen, click the "Field Mapping" tab. You'll see this message at the top:
"No fields have been provided yet, to load provider fields please click here."
16. When you click "click here", you will be directed to login with your test account that you made earlier. After logging in successfully, you'll be redirected back to Integrations Hub.
17. Standard OpenWater fields will populate under Basic Fields, OpenWater Field column- you can add or remove any that you need to by using the drop-down options:
Additional Tip:
Does the Basic Field options not include a field you need? You can add custom fields to your OpenWater instance here:
https://{YourOpenWaterInstanceName}.secure-platform.com/admin/organizations/main/userprofileformtemplate/preview
Next, in Integrations Hub, click on "Custom Fields" under "Basic Fields" on the left side of your screen. You'll now have drop-down options just like the basic fiellds shown above where you can add custom fields in the same manner.
18. Next, under the column called OAuth Field, click each one to assign the corresponding OAuth field. Do this by:
Click the empty field
Search within the payload for the exact field
Select the field that matches
Click Save
19. Once you have your field mapping configured, click "Save" in the top left of the page again. Then click "Publish".
20. When you're ready, click "Test" at the top of your screen next to "Save" and "Publish", then follow the login prompt.
21. If this test was successful, you are ready to finish your SSO setup via your OpenWater instance. First, go back to your "Settings" tab and copy the Begin URL:
22. Login to your OpenWater instance as an admin: https://{YourOpenWaterInstanceName}.secure-platform.com/admin/
23. From the dashboard settings located on the left side of your screen, scroll down to System Settings > Login Configuration
24. On this Login Configuration page, add the below settings:
Check "Allow 3rd Party Corporate Handshake Authentication"
Choose "Json Web Token" from the list
The Login URL is the Begin URL we just copied from Integrations Hub
Secret Key will be the same JWT Secret Key located in your integrations hub settings page
For your Login Button Text, we suggest: Login with {CompanyName}
Click Save
25. Your SSO is now complete- high-five yourself, you did it!
26. As with any new integration or workflow, testing is super important! Follow these steps here: https://app.intercom.com/a/apps/zujji5sg/articles/articles/6991126/show