Skip to main content

Okta

The Okta source connector syncs identity data (users, groups, roles, and system logs) from your Okta organization.

Prerequisites​

  • An Okta organization and its domain. If your Okta URL is https://MY_DOMAIN.okta.com/, then MY_DOMAIN is your Okta domain. See Find your Okta domain.
  • Credentials for one of the three supported authentication methods (see below). The credentials must belong to an administrator with permission to read the resources you want to sync. API tokens inherit the privilege level of the admin who creates them.

Setup guide​

Step 1: Set up authentication in Okta​

The connector offers three authentication methods on both Airbyte Cloud and Airbyte Open Source. Use API Token, OAuth2.0, or OAuth 2.0 with private key.

API Token​

Create an API token (SSWS token) in the Okta Admin Console under Security > API > Tokens. Record the token value when Okta displays it; you can't view it again later. See Create an API token.

Okta API tokens expire after 30 days of inactivity. If you restrict API calls to a network zone, make sure requests from Airbyte are allowed.

OAuth 2.0​

This is the OAuth2.0 option in the Airbyte UI. You need the Client ID, Client Secret, and a Refresh Token from an Okta OAuth 2.0 app integration with the Refresh Token grant type enabled. The connector uses the refresh token to obtain new access tokens when they expire.

The connector authenticates to Okta's token endpoint (https://{domain}.okta.com/oauth2/v1/token) with the client ID and secret. If Okta rotates the refresh token, the connector saves the new refresh token to the source configuration automatically.

If Okta rejects the client credentials, refresh grant, or the request's network, the sync fails with a configuration error naming the field to fix.

OAuth 2.0 with private key​

Create an API service app in your Okta org, register the public JSON Web Key (JWK) that corresponds to your PEM private key, and grant the app the OAuth 2.0 scopes for the resources you plan to sync (for example, okta.users.read, okta.groups.read, okta.roles.read, and okta.logs.read). You need:

  • Client ID: the service app's client ID.
  • Key ID: the kid of the registered JWK.
  • Private key: the corresponding private key in PEM format. You can paste it with real line breaks or with escaped \n sequences.
  • Scope: the granted scopes, separated by spaces.

The connector doesn't send Demonstrating Proof of Possession (DPoP) proofs. If the service app requires DPoP, turn off that requirement in the app's settings, or the token request fails with an invalid_dpop_proof error.

Step 2: Set up the Okta source in Airbyte​

  1. Log in to your Airbyte Cloud or Airbyte Open Source account.
  2. In the left navigation bar, click Sources. In the top-right corner, click + new source.
  3. On the source setup page, select Okta from the Source type dropdown and enter a name for the connector.
  4. Enter your Okta domain. Enter only the domain part: if your Okta URL is https://MY_DOMAIN.okta.com/, enter MY_DOMAIN. The connector always calls https://{domain}.okta.com, so if your org uses a custom domain, enter its underlying okta.com subdomain rather than the custom hostname. Orgs reachable only on other Okta hosts (such as okta-emea.com or oktapreview.com) aren't supported.
  5. Enter a Start Date in the format YYYY-MM-DDTHH:MM:SSZ. Data before this date isn't replicated. If you leave this field empty, the connector syncs data from the last 7 days only.
  6. Choose an authentication method and fill in its fields:
    • API Token: enter your Personal API Token.
    • OAuth2.0: enter your Client ID, Client Secret, and Refresh Token.
    • OAuth 2.0 with private key: enter your Client ID, Key ID, Private key, and Scope.
  7. Click Set up source.

Supported sync modes​

The Okta source connector supports the following sync modes:

  • Full Refresh
  • Incremental

Supported streams​

StreamIncrementalNotes
UsersYesCursor: lastUpdated
User Role AssignmentsNoRoles assigned to each user
GroupsYesCursor: lastUpdated
Group MembersNoMembers of each group
Group Role AssignmentsNoRoles assigned to each group
System LogYesCursor: published
Custom RolesNo
PermissionsNoPermissions of each custom role
Resource SetsNo

Performance considerations​

The connector is subject to standard Okta rate limits. Rate limits vary by endpoint and by your Okta subscription.

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

Field
Type
Property name
object
credentials
string
domain
string
start_date

Changelog​

Expand to review
VersionDatePull RequestSubject
0.4.02026-11-1191335Migrate to manifest-only. Fix OAuth 2.0 (refresh token) authentication and save rotated refresh tokens. Fix private keys saved with escaped newlines.
0.3.292026-11-1091662Update dependencies
0.3.282026-11-0490919Raise minimum supported Python version to 3.11
0.3.272026-11-0390674Update dependencies
0.3.262026-10-2790029Update dependencies
0.3.252026-10-2078853Update dependencies
0.3.242026-10-1688958Update to CDK v7 and base image 4.1.1
0.3.232026-08-2885169Remove legacy main.py from poetry package includes to fix Docker image build
0.3.222026-08-2785086Support multiline input for private key
0.3.212025-02-2554167Remove stream_state interpolation
0.3.202025-02-0152728Update dependencies
0.3.192025-01-2552469Update dependencies
0.3.182025-01-1851920Update dependencies
0.3.172025-01-1151170Update dependencies
0.3.162025-01-0450899Update dependencies
0.3.152024-12-2850670Update dependencies
0.3.142024-12-2150073Update dependencies
0.3.132024-12-1449264Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
0.3.122024-12-1249145Update dependencies
0.3.112024-11-0447900Update dependencies
0.3.102024-10-2847058Update dependencies
0.3.92024-10-1246804Update dependencies
0.3.82024-10-0546481Update dependencies
0.3.72024-09-2846148Update dependencies
0.3.62024-09-2145763Update dependencies
0.3.52024-09-1445543Update dependencies
0.3.42024-09-0745319Update dependencies
0.3.32024-08-3144977Update dependencies
0.3.22024-08-2444741Update dependencies
0.3.12024-08-1744332Update dependencies
0.3.02024-08-1343382Support OAuth 2.0 with private key
0.2.112024-08-1243820Update dependencies
0.2.102024-08-1043672Update dependencies
0.2.92024-08-0343279Update dependencies
0.2.82024-07-2742739Update dependencies
0.2.72024-07-2042284Update dependencies
0.2.62024-07-1341756Update dependencies
0.2.52024-07-1041269Update dependencies
0.2.42024-07-0640904Update dependencies
0.2.32024-06-2540316Update dependencies
0.2.22024-06-2240002Update dependencies
0.2.12024-06-0439016[autopull] Upgrade base image to v1.2.1
0.2.02024-05-1636509Migrate to Low Code
0.1.162023-07-0720833Fix infinite loop for GroupMembers stream
0.1.152023-06-2027533Fixed group member stream and resource sets stream pagination
0.1.142022-12-2420877Disabled OAuth2.0 authorization method
0.1.132022-08-1214700Add resource sets
0.1.122022-08-0515050Add parameter start_date for Logs stream
0.1.112022-08-0314739Add permissions for custom roles
0.1.102022-08-0115179Fix broken schemas for all streams
0.1.92022-07-2515001Return deprovisioned users
0.1.82022-07-1914710Implement OAuth2.0 authorization method
0.1.72022-07-1314556Add User_Role_Assignments and Group_Role_Assignments streams (full fetch only)
0.1.62022-07-1114610Add custom roles stream
0.1.52022-07-0414380Add Group_Members stream to okta source
0.1.42021-11-027584Fix incremental params for log stream
0.1.32021-09-085905Fix incremental stream defect
0.1.22021-07-014456Fix infinite pagination in logs stream
0.1.12021-06-093973Add AIRBYTE_ENTRYPOINT env variable for kubernetes support
0.1.02021-05-303563Initial Release