Okta
ThoughtFarmer is able to integrate with Okta for SSO authentication and user management. This means one less password for users to remember, and automatic syncing of user information from Okta into ThoughtFarmer. Read more below on how you can set up Okta.
If you already have active users in ThoughtFarmer and you would like to switch them over to Okta, please contact the ThoughtFarmer Helpdesk first.
Okta setup
There are two main parts to setting up Okta:
- Set up authentication into ThoughtFarmer via Okta.
- Set up user sync so user data can be synced into ThoughtFarmer from Okta.
Cloud clients, please wait for us to set up your custom URL first before you set up Okta.
Set up authentication
-
In Okta, go to the Admin section > Applications. Add a new application. Create a new application integration. Choose the sign-on method SAML 2.0.
-
Under General Settings: Choose a name and logo for your Okta application.
-
Under SAML Settings:
-
-
Single Sign-on URL: https://tfurl.com/auth/saml/assertionconsumerservice (Replace "https://tfurl.com" with the url of your ThoughtFarmer site.)
- Select the checkbox "Use this for Recipient URL and Destination URL".
- Audience URI: thoughtfarmer
- Refer to the screenshot below for the remaining settings to choose.
-
Single Sign-on URL: https://tfurl.com/auth/saml/assertionconsumerservice (Replace "https://tfurl.com" with the url of your ThoughtFarmer site.)
-
Click Next and Finish.
-
This will bring you to the page pictured below within the newly created application in Okta. Add some ThoughtFarmer users to your Okta application by clicking the Assignments tab. Click Assign and assign users so they can have access to your ThoughtFarmer intranet. Usernames and fields can be assigned on an application by application basis, so it is important that the data is set to populate the Okta application users.
- Next you will need the SAML setup instructions. Click View Setup Instructions. This opens up a page with the information that you need to set up a new Login Provider in ThoughtFarmer.
- Log into ThoughtFarmer and add a new login provider by going to Admin Panel: Users & security section > Login Provider page. Under External Providers, add a new login provider. Select Custom SAML as the type.
- Fill in the create login provider page fields as described below, using the values from Okta's setup instructions that you opened in step 4.
- Hostname: your ThoughtFarmer site URL
- Login Provider complete hostname: Okta's "Identity Provider Single Sign-On URL"
- External user store configuration: select your Okta external user store (see the User sync setup heading below on how to create it)
- Single Sign On Binding Type: HTTP Redirect
- Identity Provider Sign Out URL: https://yourOktaApiUrl.com/login/signout (The Okta API URL is your "Identity Provider Single Sign-On URL" but only the "https://....com" portion.)
- Single Sign Out Binding Type: HTTP Redirect
- Certificate details: Okta's "X.509 Certificate" (include the "BEGIN CERTIFICATE" and "END CERTIFICATE" parts)
- Configuration options: Select the checkboxes: "Want SAML Response Signed" and "Want Assertion Signed"
-
Issuer URL / Name: Okta's "Identity Provider Issuer"
User sync setup
ThoughtFarmer also has a feature that allows scheduled syncing of data from Okta into ThoughtFarmer. This allows users to be created and deactivated in ThoughtFarmer, user profiles to be updated, and membership of ThoughtFarmer groups and security groups to be based on the membership of Okta groups.
The Okta sync in ThoughtFarmer also has to be configured. See below on how to do it:
- Go to the ThoughtFarmer Admin Panel: Users & security section > Employee Directory Connector page. Click Add New external user store.
- Select the type Okta, give it a name (eg. Okta) and Save.
- For the ThoughtFarmer user you're currently logged in as, if you want that user to be an Okta user, you need to convert the account type to External.
- Go to the Admin Panel: Users & security section > User Management page.
- Search for the user. On the right of the user's listing, click the gear icon, and select Edit Account.
- Change the user type to External, add the Okta username, choose your Okta in the dropdown and Save.
- Do the same for any other existing users in ThoughtFarmer that will come from Okta. If the Okta user doesn't have a ThoughtFarmer account yet, you can let the sync create the user. If you need help bulk changing many users at a time, please submit a request to ThoughtFarmer Helpdesk.
- Go back to the Admin Panel: Users & security section > Employee Directory Connector page. Click on [your Okta]. On the Field Mappings tab, the link between the Okta data and the ThoughtFarmer data can be set. See instructions below on how to set up field mappings on both the ThoughtFarmer and Okta ends.
Field Mappings
To enhance the synchronization of user data, additional fields can be mapped in the Employee Directory Connector. This process ensures that user attributes from Entra ID are accurately imported into ThoughtFarmer.
For a detailed guide on which Entra ID attributes correspond to ThoughtFarmer fields, refer to Identity Provider Field Mappings.
This document outlines:
- Standard attributes supported
- Syntax for custom attributes
- Best practices for creating mappings.
Set up field mappings in Okta
For each field mapping in ThoughtFarmer, you'll need to set them up in Okta too. Currently, Okta does not support profile images being uploaded.
- In Okta, go to Directory > Profile Editor.
- Find your ThoughtFarmer application, and click Profile.
- Click + Add Attribute and create an attribute for each ThoughtFarmer profile field in the Field Mappings tab above. Give it the same name as the profile field in ThoughtFarmer, but without spaces and special characters.
- In Okta, click Mappings.
- Click the Okta User to <name of your application> tab.
- The Okta user profile side is where you select the profile field in Okta. The ThoughtFarmer user profile side shows the fields that Okta will map to. Select the green arrows so the field mappings can be applied on user creation and update.
Set up Okta configuration in ThoughtFarmer
After you complete the field mappings, you need to set up the configuration tab in ThoughtFarmer.
- In the ThoughtFarmer Admin Panel: Users & security section > Employee Directory Connector page. Click on [your Okta].
- Under the Configuration tab, replace the placeholder text below with your Okta details so they can be used by the Windows service for the sync.
{
"oktaApiToken": "okta_api_token_here",
"oktaApiUrl": "https://oktaapiurl",
"oktaAppName": "okta_application_name_here"
}
- Follow the steps below to locate the above values in Okta.
-
Okta Api Token
- In Okta, go to Security > API.
- Click the Tokens tab.
- Click Create Token, copy the token and paste it into ThoughtFarmer configuration.
-
Okta API Url
- In Okta, go to Applications > [your app] > Sign On.
- Click View Setup Instructions under Settings.
- The Okta API URL is your "Identity Provider Single Sign-On URL" but only the "https://....com"; portion. This excludes everything after the ".com".
-
Okta App Name
- In Okta, go to Directory > Profile Editor.
- Find your ThoughtFarmer application, and click Profile.
- Copy the "Variable name" and paste it into ThoughtFarmer.
-
Okta Api Token
- In ThoughtFarmer's Okta settings, click the Basic Information tab. If a user doesn't have a ThoughtFarmer account, but they are a member of the Okta group that ThoughtFarmer is syncing with, you can have their account automatically created after they log in without having to run a sync first. If you want this enabled, select User auto-creation.
Test Okta sync and authentication
- Go to the ThoughtFarmer Admin Panel: Users & security section > Employee Directory Connector page > [your Okta] > Synchronization Settings tab.
- At the bottom, click Validate credentials. If the setup has been done properly, then it should validate successfully and show a green banner. You may have to refresh the page a few times until it succeeds. It should only take about a minute or so.
- Check off the sync tasks that you want to run and click Synchronize Now. You can also set up a daily sync schedule so it'll run a sync automatically on a regular basis. We recommend running a Bulk Update users, so you can see which users are being pulled in without affecting your current user list.
- Click the Synchronization Logs tab. Here, you can view the status of your sync. The status should say Success after it's done. This can take several minutes depending on how many users you are syncing. Click View details after the sync is done to see who got synced in and what info was pulled from Okta.
- To test the login, create a temporary regular user with Admin privileges and then delete the regular user when you don't need it anymore. This account can serve as a backup access method in the event that Okta authentication encounters issues.
- If you want the ThoughtFarmer user that you are currently logged in as to be an Okta user, you need to convert the account type to External. To do this:
- Go to the ThoughtFarmer Admin panel: Users & security section > User Management page.
- Search for the user.
- On the right of the user entry, click the gear icon and select Edit Account in the dropdown menu.
- Change the Account type to External, add the Okta username, choose your Okta store in the dropdown menu and click Save.
- Repeat Step 6 for any other existing users in ThoughtFarmer that will come from Okta. If an Okta user doesn't have a ThoughtFarmer account yet, you can let the sync create the user. If you need help bulk changing many users at a time, please open a Support request on our Helpdesk.
Comments
0 comments
Please sign in to leave a comment.