Okta
  • 01 Sep 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Okta

  • Dark
    Light

Article summary

Connection

The integration with Okta utilizes an API Key for connection.

To set up credentials, you need to create a dedicated application for API Services within your Okta tenant.

Step 1 - Creating an App

  • In the Applications section of your Okta admin console, click Create App Integration and select API Services app from the pop up that follows.

  • Give your app a name.

Step 2 - Config Scopes

Now that the integration is created, go to the OKTA API Scopes tab and grant access to the following scopes:

  • okta.users.read

  • okta.groups.read

  • okta.userTypes.read

Step 3 - Config Credentials

  • Go to the General tab and edit the Client Credentials section.

  • Change the Client authentication type to Public key/Private key .

  • Click Add key to generate a new key.

  • Copy the private key and save the new key pair.

  • Disable DPoP (Demonstrating Proof of Possession) by unchecking the box in the General Settings section

Finally, paste the new Private Key and Client ID values in the connection screen in your Unleash workspace.

Step 4 - Assign Admin Role

So that the granted scopes will be effective you will need to assign your app a read-only admin role.

You can do that by navigating the Admin roles tab and assigning a Read-only Administrator role like the following screenshot:

Scopes

The integration necessitates the following scopes:

okta.groups.read
okta.userTypes.read
okta.users.read

Supported Resources

The integration currently supports the following resource:

  • Users

Sync

The integration does not support incremental updates and hence sync is scheduled for every 6 hours.

API Calls

The table below details the primary endpoints utilized by the integration:

Endpoint

Docs

Purpose

/api/v1/users

https://developer.okta.com/docs/reference/api/users/#list-users

List users in the tenant

HRIS

The Okta integration can be configured as an HRIS (Human Resources Information System) to activate the People view feature.

For more information:


Was this article helpful?