Okta API Service integration guide

Okta API Service is an integration that allows you to import users from Okta into Deel and use them for third-party user provisioning use cases.

This article explains how to set up the Okta API Service integration.

Want to sync your Deel data with Okta SCIM?

The Deel and Okta SCIM integration enables Deel HR clients to automatically sync employee data from Deel into Okta, allowing IT teams to provision users into other applications such as Zendesk, Salesforce, and more. Refer to the Enabling the Okta SCIM integration for Deel HR documentation page for instructions on how to enable the Deel and Okta integration.

In this article

Here’s what you’ll find in this article:

• Before you begin
• Step 1. Prepare Okta API Service
• Step 2. Connect the integration
• Step 3. Configure the integration
• Step 4. Sync data manually
• Okta API Service integration reference

Before you begin

To successfully set up the Okta API Service integration, you’ll need:

• A user with an admin role on Deel
• A user with an admin role on Okta
• Permission to view and manage integrations in Deel

Step 1. Prepare Okta API Service

In this section, we’ll guide you through how to configure Okta API Service so that you can connect to it.

To connect Okta API Service to Deel, you’ll need to enable permissions and prepare your account credentials — including the domain URL, client ID, and private JSON key.

Enable Okta API Service permissions

Create an App Integration in Okta to enable permissions for the Okta API Service.

1. Go to Applications > Applications > Create App Integration, select the API Services option and click Next.
2. Name your integration and click Save.
3. Navigate to Okta API Scopes and grant the following scopes:
   1. okta.users.read
   2. okta.schemas.read
   3. okta.userTypes.read
4. Under Admin roles, select Edit assignments and assign an admin role to the integration with permission to read users, schemas, and user types. You can use Organization Administrator.

Get Client ID and Private Key

After enabling the Okta API Service permissions, you need to get your Client ID and Private Key.

To get your Client ID:

On your Okta account, go to Applications > General > Client Credentials and copy the Client ID. 

To get your Private Key:

1. In Okta, go to Settings, click Edit, and deselect Proof of possession, then click Save.
2. On Applications > General > Client Credentials and click on Edit.
3. Select Public key / Private key for Client Authentication.
4. Under Public Keys, click on Add key > Generate new key.
5. Copy the Private Key and click Save.

Step 2. Connect the integration

In this section, we’ll guide you through how to connect Deel to Okta API Service from the Deel App Store.

1. In the left sidebar, select Apps & Automation to expand its submenu.
2. Select App Store.
   
3. If the Welcome to your Deel Apps & Integrations dialog appears, close it with the X or select I'll do that later.
   
4. In the Find apps search field, enter Okta API Service.
   
5. Select Okta API Service from the filtered results. Confirm that the result description is Import User Information from Okta.
   
6. On the Okta API Service integration details page, click Connect Okta API Service.
   
7. On the Okta API Service connection page, enter your account credentials and click Connect & go to settings.

The integration is now connected, and you can start to configure the integration.

Step 3. Configure the integration

In this section, we’ll guide you through configuring the integration so that data can sync successfully.

To activate the worker data sync:

1. On the connected Okta API Service integration page, go to Plugins and settings.
2. On the Worker data sync for non-payroll plugin, click Enable.
3. Acknowledge the pop-up and click Continue.
4. (Optional) On the Worker data sync page, turn on automatic invitations if you want workers to be automatically invited to Deel.
5. Map the Deel fields with the values coming from your HRIS system, then click Continue.

See the Okta API Service integration reference for a complete list of supported fields.

Use filtering to avoid duplicates

If you are importing worker data and you also use Deel Payroll, to avoid duplicates, you must exclude workers who already have a contract that is managed through Deel from the sync. You can do so using the AI filter when reviewing the list of workers.

1. On the Import workers tab, review which worker profiles to import based on your set criteria, then click Continue to import.
2. In the Ready to Sync pop-up modal, click Sync to start importing the selected worker profiles.

The selected worker profiles will be imported into Deel from Okta. You’ll receive a notification once the results are available.

Step 4. Sync data manually

Automatic syncs occur daily, one way from Okta API Service to Deel, but you can manually trigger a sync:

• If you’ve made important changes and need them to sync immediately
• If you notice missing data or errors, that suggests that the last sync didn’t complete correctly

1. In the left sidebar, select Apps & Automation to expand its submenu, then select App Store.
2. Use Find apps to search for Okta API Service and select the result labeled Import User Information from Okta.
3. On the connected integration page, click Sync Okta API Service.

Recent changes in Okta API Service will be synced to Deel.

Okta API Service integration reference

This section provides information about the capabilities and limitations of the integration. You can use it to understand whether the integration can sync the data you need to sync.

Supported fields

The Okta API Service integration supports the sync of the following mapping fields:

Troubleshooting