Okta

How to Configure SAML 2.0 for BrainStorm QuickHelp

Contents


Supported Features

The Okta/Brainstorm QuickHelp SAML integration currently supports the following features:


Configuration Steps

  1. Contact BrainStorm support and request that they enable SAML for your organization.
  2. Copy and save the following IdP Metadata show below with the filename metadata.xml.

    Sign into the Okta Admin dashboard to generate this value.
  3. Attach the file you saved in step 2 to the email message.

  4. BrainStorm will process your request. When you receive a confirmation that SAML is enabled, you can start assigning users to the application.
  5. The BrainStorm QuickHelp application is pre-configured to pass the groups as part of the SAML assertion. In order to send user groups as part of the SAML assertion:

    • In OKTA, select the Sign On tab for the BrainStorm QuickHelp app, then click Edit.

    • Select your preferred group filter from the Group dropdown list (the Regex rule with the value ".*" in order to send *all* groups to the BrainStorm QuickHelp instance we used in our example) for the attribute.

    • Click Save.

    • “brainstorm1.png"

  6. Done!


Notes

The following SAML attributes are supported:

Okta sends the following default attributes as part of the SAML assertion:

In addition to the default attributes, Okta supports the following custom attributes:

Here is an example describing how to add and use the additional company attribute.

  1. In Okta, navigate to Directory > Profile Editor.

  2. Search for the BrainStorm QuickHelp app, then click Profile:

  3. brainstorm_new1.png

  4. Click Add Attribute, then enter the following:

    1. Display Name: Enter a preferred attribute name. In our example, we used Company.

    2. Variable Name: company.

      Important: In our example we are adding the company attribute. You must use the following variables names for the custom attributes: userId, company, location, platform, custom1, custom2, and custom3.

    3. Click either Add Attribute or Save, and Add Another.

    Note: Scope (optional): If you check User personal, it means that the current attribute will be available once you assign the user to the BrainStorm QuickHelp application and will not be available once you assign the group to the app.

    brainstorm_new2.png

  5. Click Map Attributes:

    brainstorm_new3.png

  6. Select the Okta to BrainStorm QuickHelp tab.

  7. Start typing the required attribute from the Okta Base User profile (or use the drop down list) and select the attributes you want to map.

  8. In our example, we have selected the Organization< attribute, then use the green arrows (Apply mapping on user create and update).

  9. Click Save Mappings:

  10. brainstorm_new4.png

  11. Click Apply Updates Now:

  12. brainstorm_new5.png

  13. Okta will now pass the Company attribute with the value of the Organization field from the Okta Base User Profile.

For SP-initiated SSO

  1. Go to: https://quickhelp.com/Login

  2. Enter your Email Address.

  3. Click LOG IN:

  4. “brainstorm.png"