Articles in this section

Setup Guide: ActivTrak for SCIM-Okta‬ Integration (EA)‬

Contents

What is SCIM?

The System for Cross-domain Identity Management (SCIM) is a standard protocol that automates the exchange of user identity information between systems, thereby reducing manual work and security risks.

Use cases‬

The ActivTrak-OKTA integration via SCIM API (Early Access) supports these admin capabilities:‬

  1. User provisioning‬: Automatically creates ActivTrak user accounts when users are added to your identity provider

Note: ActivTrak Agent install is required separately

  1. User deprovisioning‬: Automatically removes user access when accounts are deactivated in your identity provider

Note: ActivTrak Agent uninstall is required separately

  1. Group Management‬: Automatically adds and removes users to ActivTrak Groups based on group membership in your identity provider

Requirements

  • ActivTrak SCIM API key via the ActivTrak App - Integrations page
  • Access to the Okta Admin Console
  • Permissions to manage applications within Okta

Setup instructions‬

Generate ActivTrak SCIM API key

  1. Log in to the ActivTrak application
  2. Navigate to APIs & Integrations > Integrations
  3. Locate the OKTA via SCIM card and click + Add Instance

 

  1. The OKTA via SCIM drawer will open. Input an API Key Name. Copy and store the API Key. Then click Save.

Note: The key can only be copied at this time. If lost, it can be regenerated.

 

  1. Once the process is complete, the card will display the View Instance button

Create an SSO integration that supports SCIM‬

Using the App Integration Wizard, create a custom SSO integration using either SAML or SWA:‬

Walkthrough of SWA‬

  1. In the Okta Admin Console, click Admin on the top right
unnamed (26).png

 

  1. Navigate to Applications > Applications
unnamed (25).png

 

  1. Click Create App Integration
unnamed (24).png

 

  1. Select SWA (Secure Web Authentication)
unnamed (23).png

 

  1. Add General Settings‬
  2. Set the‬ App’s login page URL‬ field to:‬ https://api.activtrak.com/auth/v2/authenticate
unnamed (22).png

 

  1. Set‬ the Who sets the credentials‬‭ field to “Administrator sets Username and Password”
  2. Set the‬ Application username‬‭ field to “Email”
  3. Set‬ the Update applicationusername‬ field to “Create and Update”
unnamed (21).png

Configure the ActivTrak SCIM Integration‬

  1. After creating your SWA integration, click the General tab
  2. In the App Settings section, click Edit
unnamed (20).png

 

  1. In the Provisioning field, select SCIM, then click Save
unnamed (19).png

 

  1. Select the Provisioning tab
unnamed (18).png

 

  1. Set the SCIM connector base URL based on your ActivTrak instance location:

US instances: https://api.activtrak.com/scim/v1

EU instances: https://api-eu.activtrak.com/scim/v1

Other regions: Check our API documentation for your specific base URL

  1. Set‬ the Unique identifier field for users‬ to “userName”
  2. Check the following desired actions‬:
    • Push New Users‬
    • Push Profile Updates‬
    • Push Groups‬
unnamed (17).png

 

  1. In authentication mode, select HTTP header, and paste your Activtrak API key into the token‬ textbox
unnamed (16).png

 

  1. Testing the configuration should display the following:‬
unnamed (15).png

Enable Provisioning Options‬

  1. In the Provisioning tab, select To App from the left column
  2. Click Edit
unnamed (14).png

 

  1. Enable these options:
    • Create Users
    • Update User Attributes
    • Deactivate Users
unnamed (13).png

Remove unsupported mappings‬

  1. In the Provisioning tab under To App options, scroll to SCIM AT Attribute Mappings
  2. Click Go to Profile Editor
unnamed (12).png

 

  1. Click on Mappings
unnamed (11).png

 

 

  1. Select “Do not map” for the following mapping fields:
  • honoricPrefix‬
  • honoricSuffix‬
  • profileUrl‬
  • nickName‬
  • primaryPhone‬
  • streetAddress‬
  • locality‬
  • region‬
  • postalCode‬
  • country‬
  • formatted‬
  • preferredLanguage‬
  • locale‬
  • timezone‬
  • userType‬
  • costCenter‬
  • organization‬
  • division‬
  • department‬
  • managerValue‬
  • managerDisplayName‬
unnamed (10).png

 

  1. Verify that the following mapping fields remain:‬
  • givenName‬
  • familyName‬
  • middleName‬
  • email‬
  • displayName‬
  • employeeNumber‬

 

  1. Return to the Attributes screen and delete the following:
  • honoricPrefix‬
  • honoricSuffix‬
  • profileUrl‬
  • nickName‬
  • Primary Phone‬‬
  • Primary phone type‬
  • Street Address‬
  • Address type‬
  • locality‬
  • region‬
  • postalCode‬
  • country‬
  • formatted‬
  • preferredLanguage‬
  • locale‬
  • timezone‬
  • userType‬
  • costCenter‬
  • organization‬
  • division‬
  • department‬
  • managerValue‬
  • managerDisplayName‬

 

  1. Verify that the following Attributes remain:
  • userName‬
  • givenName‬
  • familyName‬
  • middleName‬
  • email‬
  • emailType‬
  • displayName‬
  • employeeNumber‬
unnamed (8).png

Add Users and Groups

To push users to ActivTrak from Okta:

  1. From the applications list, click the gear icon for ActivTrak SCIM SWA and select Assign to users
unnamed (7).png

 

  1. Select from the list of unassigned users and click Assign to provision them to your SCIM application
unnamed (4).png

 

  1. Alternatively, you can select the application and click Assign > Assign to people
unnamed (5).png

 

Note: To push users to ActivTrak from Okta, users must exist in Directory > People. To create a new user, click the Add Person button. The user will receive an email to complete their Okta account setup.

To push groups to ActivTrak from Okta:

  1. Create Okta groups in Directory > Groups
unnamed (3).png

 

  1. In the SCIM SWA app, select Push Groups
unnamed (1).png

 

  1. Assign the groups you want to sync to the Groups page in ActivTrak
unnamed.png

 

Note: Users with multiple agents will have each agent added to groups as a separate member. Therefore, the number of group members may be larger in ActivTrak than in Okta. For example, if Tyler has 2 user agents, adding him to a group will result in 2 members. You can merge these user agents to consolidate group membership.

Your ActivTrak SCIM integration is now set up! Users and groups will be automatically provisioned according to your settings.

Learn more

Was this article helpful?
1 out of 1 found this helpful