Skip to main content

Okta

Module okta

Certified

Important Capabilities

CapabilityStatusNotes
DescriptionsOptionally enabled via configuration

This plugin extracts the following:

  • Users
  • Groups
  • Group Membership

from your Okta instance.

Extracting DataHub Users

Usernames

Usernames serve as unique identifiers for users on DataHub. This connector extracts usernames using the "login" field of an Okta User Profile. By default, the 'login' attribute, which contains an email, is parsed to extract the text before the "@" and map that to the DataHub username.

If this is not how you wish to map to DataHub usernames, you can provide a custom mapping using the configurations options detailed below. Namely, okta_profile_to_username_attr and okta_profile_to_username_regex.

Profiles

This connector also extracts basic user profile information from Okta. The following fields of the Okta User Profile are extracted and mapped to the DataHub CorpUserInfo aspect:

  • display name
  • first name
  • last name
  • email
  • title
  • department
  • country code

Extracting DataHub Groups

Group Names

Group names serve as unique identifiers for groups on DataHub. This connector extracts group names using the "name" attribute of an Okta Group Profile. By default, a URL-encoded version of the full group name is used as the unique identifier (CorpGroupKey) and the raw "name" attribute is mapped as the display name that will appear in DataHub's UI.

If this is not how you wish to map to DataHub group names, you can provide a custom mapping using the configurations options detailed below. Namely, okta_profile_to_group_name_attr and okta_profile_to_group_name_regex.

Profiles

This connector also extracts basic group information from Okta. The following fields of the Okta Group Profile are extracted and mapped to the DataHub CorpGroupInfo aspect:

  • name
  • description

Extracting Group Membership

This connector additional extracts the edges between Users and Groups that are stored in Okta. It maps them to the GroupMembership aspect associated with DataHub users (CorpUsers). Today this has the unfortunate side effect of overwriting any Group Membership information that was created outside of the connector. That means if you've used the DataHub REST API to assign users to groups, this information will be overridden when the Okta source is executed. If you intend to always pull users, groups, and their relationships from your Identity Provider, then this should not matter.

This is a known limitation in our data model that is being tracked by this ticket.

Filtering and Searching

You can also choose to ingest a subset of users or groups to Datahub by adding flags for filtering or searching. For users, set either the okta_users_filter or okta_users_search flag (only one can be set at a time). For groups, set either the okta_groups_filter or okta_groups_search flag. Note that these are not regular expressions. See below for full configuration options.

CLI based Ingestion

Install the Plugin

pip install 'acryl-datahub[okta]'

Starter Recipe

Check out the following recipe to get started with ingestion! See below for full configuration options.

For general pointers on writing and running a recipe, see our main recipe guide.

source:
type: okta
config:
# Coordinates
okta_domain: "dev-35531955.okta.com"

# Credentials
okta_api_token: "11be4R_M2MzDqXawbTHfKGpKee0kuEOfX1RCQSRx99"

sink:
# sink configs

Config Details

Note that a . is used to denote nested fields in the YAML recipe.

View All Configuration Options
FieldRequiredTypeDescriptionDefault
okta_domainstringThe location of your Okta Domain, without a protocol. Can be found in Okta Developer console. e.g. dev-33231928.okta.comNone
okta_api_tokenstringAn API token generated for the DataHub application inside your Okta Developer Console. e.g. 00be4R_M2MzDqXawbWgfKGpKee0kuEOfX1RCQSRx00None
ingest_usersbooleanWhether users should be ingested into DataHub.True
ingest_groupsbooleanWhether groups should be ingested into DataHub.True
ingest_group_membershipbooleanWhether group membership should be ingested into DataHub. ingest_groups must be True if this is True.True
okta_profile_to_username_attrstringWhich Okta User Profile attribute to use as input to DataHub username mapping.login
okta_profile_to_username_regexstringA regex used to parse the DataHub username from the attribute specified in okta_profile_to_username_attr.(@+)
okta_profile_to_group_name_attrstringWhich Okta Group Profile attribute to use as input to DataHub group name mapping.name
okta_profile_to_group_name_regexstringA regex used to parse the DataHub group name from the attribute specified in okta_profile_to_group_name_attr.(.*)
include_deprovisioned_usersbooleanWhether to ingest users in the DEPROVISIONED state from Okta.False
include_suspended_usersbooleanWhether to ingest users in the SUSPENDED state from Okta.False
page_sizeintegerThe number of entities requested from Okta's REST APIs in one request.100
delay_secondsGeneric dictNumber of seconds to wait between calls to Okta's REST APIs. (Okta rate limits). Defaults to 10ms.0.01
okta_users_filterstringOkta filter expression (not regex) for ingesting users. Only one of okta_users_filter and okta_users_search can be set. See (https://developer.okta.com/docs/reference/api/users/#list-users-with-a-filter) for more info.None
okta_users_searchstringOkta search expression (not regex) for ingesting users. Only one of okta_users_filter and okta_users_search can be set. See (https://developer.okta.com/docs/reference/api/users/#list-users-with-search) for more info.None
okta_groups_filterstringOkta filter expression (not regex) for ingesting groups. Only one of okta_groups_filter and okta_groups_search can be set. See (https://developer.okta.com/docs/reference/api/groups/#filters) for more info.None
okta_groups_searchstringOkta search expression (not regex) for ingesting groups. Only one of okta_groups_filter and okta_groups_search can be set. See (https://developer.okta.com/docs/reference/api/groups/#list-groups-with-search) for more info.None
mask_group_idbooleanTrue
mask_user_idbooleanTrue

As a prerequisite, you should create a DataHub Application within the Okta Developer Console with full permissions to read your organization's Users and Groups.

Compatibility

Validated against Okta API Versions:

  • 2021.07.2

    Validated against load:

  • User Count: 1000

  • Group Count: 100

  • Group Membership Edges: 1000 (1 per User)

  • Run Time (Wall Clock): 2min 7sec

Code Coordinates

  • Class Name: datahub.ingestion.source.identity.okta.OktaSource
  • Browse on GitHub

Questions

If you've got any questions on configuring ingestion for Okta, feel free to ping us on our Slack