In This Article
Before You Begin
You need four items to provision Lessonly users via Okta:
The company's Okta URL.
This should look like
A read-only Okta API token.
A new user in the Okta directory with read-only access and a token for this user.
This ensures Lessonly cannot accidentally make a change in the Okta environment or, if an Admin leaves, Lessonly won't need to update the script.
An Okta group to sync to Lessonly.
Lessonly can sync the entire Okta directory, but it's better to target a specific group in the Okta account.
Required User Profile Attributes
At a minimum, you must complete the following fields for each user:
Name, first and last.
Lessonly user role.
Learner, creator, manager, or admin. If a role is not filled out, the user will default to a learner.
Other standard fields that can be included for each user are as follows:
For custom user fields to sync, Lessonly needs to know the variable name of the field in Okta. This can be found in the Okta Profile Editor.
Custom attributes could include the following:
External user ID
When setting up the standard Okta integration, mapping attributes need to be set up in the customer's Okta instance.
In Okta, navigate to Directory > Profile Editor, and locate the Lessonly app (if there are multiple Lessonly apps this will have to be done for all of them). Select the profile editor button for the app. The Profile Editor page is where the attributes are mapped out.
After the desired attributes have been created in the app profile, these attributes need to be mapped to their corresponding fields in Okta by selecting the Map Attributes button.
Any other custom field needs to be provided by the customer with both the
variableName and the
Lessonly field name.
In the attribute mapping settings, there are two options at the top:
Lessonly to Okta
Okta to Lessonly
Select Okta to Lessonly. The sync must go from Okta to the application for it to work successfully.
On the left-hand side, the attributes are listed to be synced from Okta to the corresponding attribute in Lessonly. Between the attributes is an arrow. The user must select the arrow and select Apply mapping on user create and update. This is not intuitive but critical. The arrow should be green and pointing to the right. If the arrow is yellow then the attributes only sync for new users, and won't update previously synced users.
Select Save and the set-up is finalized.
Important Notes About Mapping Attributes
When adding attributes, the Display Name of the attribute does not matter, but the Variable Name must match exactly.
Dates in Lessonly are in ISO8601 format (YYYY/MM/DD). The Hire Date field must match this formatting.
Groups won't automatically map during a standard integration. To recreate Okta groups in Lessonly, create a smart group according to some attribute that all group members share, e.g., manager name or department. Users will then be sorted according to the rules you set for each smart group.
How to Archive Users
Lessonly archives any users who are deactivated in Okta, and will restore users when they are reactivated.
Synchronization occurs twice daily at 6:00 AM UTC and 3:00 PM UTC. These times cannot be customized.
If you're looking for real-time authorization see this article about Okta SCIM.
Questions? Contact the Support team at email@example.com