Skip to main content

Azure AD

Extracting DataHub Users

Usernames

Usernames serve as unique identifiers for users on DataHub. This connector extracts usernames using the "userPrincipalName" field of an Azure AD User Response, which is the unique identifier for your Azure AD users.

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, azure_ad_response_to_username_attr and azure_ad_response_to_username_regex.

Responses

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

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

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 Azure Group Response. 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, azure_ad_response_to_groupname_attr and azure_ad_response_to_groupname_regex.

Responses

This connector also extracts basic group information from Azure. The following fields of the Azure AD Group Response 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 Azure AD. 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 Azure AD 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.

Module azure-ad

Certified

This plugin extracts the following:

  • Users
  • Groups
  • Group Membership

from your Azure AD instance.

Extracting DataHub Users

Usernames

Usernames serve as unique identifiers for users on DataHub. This connector extracts usernames using the "userPrincipalName" field of an Azure AD User Response, which is the unique identifier for your Azure AD users.

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, azure_ad_response_to_username_attr and azure_ad_response_to_username_regex.

Responses

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

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

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 Azure Group Response. 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, azure_ad_response_to_groupname_attr and azure_ad_response_to_groupname_regex.

Responses

This connector also extracts basic group information from Azure. The following fields of the Azure AD Group Response 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 Azure AD. 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 Azure AD 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.

Prerequisite

Create a DataHub Application within the Azure AD Portal with the permissions to read your organization's Users and Groups. The following permissions are required, with the Application permission type:

  • Group.Read.All
  • GroupMember.Read.All
  • User.Read.All

CLI based Ingestion

Install the Plugin

pip install 'acryl-datahub[azure-ad]'

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: "azure-ad"
config:
client_id: "00000000-0000-0000-0000-000000000000"
tenant_id: "00000000-0000-0000-0000-000000000000"
client_secret: "xxxxx"
redirect: "https://login.microsoftonline.com/common/oauth2/nativeclient"
authority: "https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000"
token_url: "https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/oauth2/token"
graph_url: "https://graph.microsoft.com/v1.0"
ingest_users: True
ingest_groups: True
groups_pattern:
allow:
- ".*"
users_pattern:
allow:
- ".*"

sink:
# sink configs

Config Details

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

View All Configuration Options
FieldRequiredTypeDescriptionDefault
client_idstringApplication ID. Found in your app registration on Azure AD PortalNone
tenant_idstringDirectory ID. Found in your app registration on Azure AD PortalNone
client_secretstringClient secret. Found in your app registration on Azure AD PortalNone
authoritystringThe authority (https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-client-application-configuration) is a URL that indicates a directory that MSAL can request tokens from.None
token_urlstringThe token URL that acquires a token from Azure AD for authorizing requests. This source will only work with v1.0 endpoint.None
redirectstringRedirect URI. Found in your app registration on Azure AD Portal.https://login.microsoftonline.com/common/oauth2/nativeclient
graph_urlstringMicrosoft Graph API endpointhttps://graph.microsoft.com/v1.0
azure_ad_response_to_username_attrstringWhich Azure AD User Response attribute to use as input to DataHub username mapping.userPrincipalName
azure_ad_response_to_username_regexstringA regex used to parse the DataHub username from the attribute specified in azure_ad_response_to_username_attr.(.*)
azure_ad_response_to_groupname_attrstringWhich Azure AD Group Response attribute to use as input to DataHub group name mapping.displayName
azure_ad_response_to_groupname_regexstringA regex used to parse the DataHub group name from the attribute specified in azure_ad_response_to_groupname_attr.(.*)
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
ingest_groups_usersbooleanThis option is useful only when ingest_users is set to False and ingest_group_membership to True. As effect, only the users which belongs to the selected groups will be ingested.True
filtered_trackingbooleanIf enabled, report will contain names of filtered users and groups.True
mask_group_idbooleanWhether workunit ID's for groups should be masked to avoid leaking sensitive information.True
mask_user_idbooleanWhether workunit ID's for users should be masked to avoid leaking sensitive information.True
users_patternAllowDenyPattern (see below for fields)regex patterns for users to filter in ingestion.{'allow': ['.*'], 'deny': [], 'ignoreCase': True}
users_pattern.allowArray of stringList of regex patterns to include in ingestion['.*']
users_pattern.denyArray of stringList of regex patterns to exclude from ingestion.[]
users_pattern.ignoreCasebooleanWhether to ignore case sensitivity during pattern matching.True
groups_patternAllowDenyPattern (see below for fields)regex patterns for groups to include in ingestion.{'allow': ['.*'], 'deny': [], 'ignoreCase': True}
groups_pattern.allowArray of stringList of regex patterns to include in ingestion['.*']
groups_pattern.denyArray of stringList of regex patterns to exclude from ingestion.[]
groups_pattern.ignoreCasebooleanWhether to ignore case sensitivity during pattern matching.True

As a prerequisite, you should create a DataHub Application within the Azure AD Portal with the permissions to read your organization's Users and Groups. The following permissions are required, with the Application permission type:

  • Group.Read.All
  • GroupMember.Read.All
  • User.Read.All

You can add a permission by navigating to the permissions tab in your DataHub application on the Azure AD portal. Azure AD API Permissions

You can view the necessary endpoints to configure by clicking on the Endpoints button in the Overview tab. Azure AD Endpoints

Code Coordinates

  • Class Name: datahub.ingestion.source.identity.azure_ad.AzureADSource
  • Browse on GitHub

Questions

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