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:
- User provisioning: Automatically creates ActivTrak user accounts when users are added to your identity provider
Note: ActivTrak Agent install is required separately
- User deprovisioning: Automatically removes user access when accounts are deactivated in your identity provider
Note: ActivTrak Agent uninstall is required separately
- 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
- Log in to the ActivTrak application
- Navigate to APIs & Integrations > Integrations
- Locate the OKTA via SCIM card and click + Add Instance
- 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.
- 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
- In the Okta Admin Console, click Admin on the top right
- Navigate to Applications > Applications
- Click Create App Integration
- Select SWA (Secure Web Authentication)
- Add General Settings
- Set the App’s login page URL field to: https://api.activtrak.com/auth/v2/authenticate
- Set the Who sets the credentials field to “Administrator sets Username and Password”
- Set the Application username field to “Email”
- Set the Update applicationusername field to “Create and Update”
Configure the ActivTrak SCIM Integration
- After creating your SWA integration, click the General tab
- In the App Settings section, click Edit
- In the Provisioning field, select SCIM, then click Save
- Select the Provisioning tab
- 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
- Set the Unique identifier field for users to “userName”
- Check the following desired actions:
- Push New Users
- Push Profile Updates
- Push Groups
- In authentication mode, select HTTP header, and paste your Activtrak API key into the token textbox
- Testing the configuration should display the following:
Enable Provisioning Options
- In the Provisioning tab, select To App from the left column
- Click Edit
- Enable these options:
- Create Users
- Update User Attributes
- Deactivate Users
Remove unsupported mappings
- In the Provisioning tab under To App options, scroll to SCIM AT Attribute Mappings
- Click Go to Profile Editor
- Click on Mappings
- Select “Do not map” for the following mapping fields:
|
|
|
- Verify that the following mapping fields remain:
|
|
- Return to the Attributes screen and delete the following:
|
|
|
- Verify that the following Attributes remain:
|
|
Add Users and Groups
To push users to ActivTrak from Okta:
- From the applications list, click the gear icon for ActivTrak SCIM SWA and select Assign to users
- Select from the list of unassigned users and click Assign to provision them to your SCIM application
- Alternatively, you can select the application and click Assign > Assign to people
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:
- Create Okta groups in Directory > Groups
- In the SCIM SWA app, select Push Groups
- Assign the groups you want to sync to the Groups page in ActivTrak
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.