schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
datahub_ingestion_schema.json
include_table_lineage
Option to enable/disable lineage generation.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_ownership
Option to enable/disable ownership generation for metastores, catalogs, schemas, and tables.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
include_column_lineage
Option to enable/disable lineage generation. Currently we have to call a rest call per column to get column level lineage due to the Databrick api which can slow down ingestion.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_usage_statistics
Generate usage statistics.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
profiling
Data profiling configuration
{"default": {"enabled": false, "operation_config": {"lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null}, "warehouse_id": null, "profile_table_level_only": false, "pattern": {"allow": [".*"], "deny": [], "ignoreCase": true}, "call_analyze": true, "max_wait_secs": 3600, "max_workers": 10}, "allOf": [{}]}
datahub_ingestion_schema.json
path
Path to Feast repository
{"type": "string"}
datahub_ingestion_schema.json
fs_yaml_file
Path to the `feature_store.yaml` file used to configure the feature store
{"type": "string"}
datahub_ingestion_schema.json
environment
Environment to use when constructing URNs
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
mode_config
Any non-Dataset source that produces lineage to Datasets should inherit this class. e.g. Orchestrators, Pipelines, BI Tools etc.
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "platform_instance_map": {"type": "object", "additionalProperties": {"type": "string"}}, "connect_uri": {"default": "https://app.mode.com", "type": "string"}, "token": {"type": "string"}, "password": {"type": "string", "writeOnly": true, "format": "password"}, "workspace": {"type": "string"}, "default_schema": {"default": "public", "type": "string"}, "owner_username_instead_of_email": {"default": true, "type": "boolean"}, "api_options": {"default": {"retry_backoff_multiplier": 2, "max_retry_interval": 10, "max_attempts": 5}, "allOf": [{}]}}, "required": ["token", "password"], "additionalProperties": false}
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
platform_instance_map
A holder for platform -> platform_instance mappings to generate correct dataset urns
{"type": "object", "additionalProperties": {"type": "string"}}
datahub_ingestion_schema.json
connect_uri
Mode host URL.
{"default": "https://app.mode.com", "type": "string"}
datahub_ingestion_schema.json
token
Mode user token.
{"type": "string"}
datahub_ingestion_schema.json
password
Mode password for authentication.
{"type": "string", "writeOnly": true, "format": "password"}
datahub_ingestion_schema.json
default_schema
Default schema to use when schema is not provided in an SQL query
{"default": "public", "type": "string"}
datahub_ingestion_schema.json
owner_username_instead_of_email
Use username for owner URN instead of Email
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
api_options
Retry/Wait settings for Mode API to avoid "Too many Requests" error. See Mode API Options below
{"default": {"retry_backoff_multiplier": 2, "max_retry_interval": 10, "max_attempts": 5}, "allOf": [{}]}
datahub_ingestion_schema.json
sqlalchemy_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "stateful_ingestion": {}, "options": {"type": "object"}, "schema_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "table_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "view_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "profile_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "domain": {"default": {}, "type": "object", "additionalProperties": {}}, "include_views": {"default": true, "type": "boolean"}, "include_tables": {"default": true, "type": "boolean"}, "include_table_location_lineage": {"default": true, "type": "boolean"}, "profiling": {"default": {"enabled": false, "operation_config": {"lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null}, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null}, "allOf": [{}]}, "platform": {"type": "string"}, "connect_uri": {"type": "string"}}, "required": ["platform", "connect_uri"], "additionalProperties": false}
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
platform_instance
The instance of the platform that all assets produced by this recipe belong to
{"type": "string"}
datahub_ingestion_schema.json
options
Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.
{"type": "object"}
datahub_ingestion_schema.json
schema_pattern
Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
table_pattern
Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
view_pattern
Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
profile_pattern
Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
domain
Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like "Marketing".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.
{"default": {}, "type": "object", "additionalProperties": {}}
datahub_ingestion_schema.json
include_views
Whether views should be ingested.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_tables
Whether tables should be ingested.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_table_location_lineage
If the source supports it, include table lineage to the underlying storage location.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
platform
Name of platform being ingested, used in constructing URNs.
{"type": "string"}
datahub_ingestion_schema.json
connect_uri
URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls
{"type": "string"}
datahub_ingestion_schema.json
hana_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "stateful_ingestion": {}, "options": {"type": "object"}, "schema_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "table_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "view_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "profile_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "domain": {"default": {}, "type": "object", "additionalProperties": {}}, "include_views": {"default": true, "type": "boolean"}, "include_tables": {"default": true, "type": "boolean"}, "include_table_location_lineage": {"default": true, "type": "boolean"}, "profiling": {"default": {"enabled": false, "operation_config": {"lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null}, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null}, "allOf": [{}]}, "username": {"type": "string"}, "password": {"type": "string", "writeOnly": true, "format": "password"}, "host_port": {"default": "localhost:39041", "type": "string"}, "database": {"type": "string"}, "database_alias": {"type": "string"}, "scheme": {"default": "hana+hdbcli", "type": "string"}, "sqlalchemy_uri": {"type": "string"}}, "additionalProperties": false}
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
platform_instance
The instance of the platform that all assets produced by this recipe belong to
{"type": "string"}
datahub_ingestion_schema.json
options
Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.
{"type": "object"}
datahub_ingestion_schema.json
schema_pattern
Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
table_pattern
Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
view_pattern
Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
profile_pattern
Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
domain
Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like "Marketing".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.
{"default": {}, "type": "object", "additionalProperties": {}}
datahub_ingestion_schema.json
include_views
Whether views should be ingested.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_tables
Whether tables should be ingested.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_table_location_lineage
If the source supports it, include table lineage to the underlying storage location.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
username
username
{"type": "string"}
datahub_ingestion_schema.json
password
password
{"type": "string", "writeOnly": true, "format": "password"}
datahub_ingestion_schema.json
database
database (catalog)
{"type": "string"}
datahub_ingestion_schema.json
database_alias
[Deprecated] Alias to apply to database when ingesting.
{"type": "string"}
datahub_ingestion_schema.json
sqlalchemy_uri
URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.
{"type": "string"}
datahub_ingestion_schema.json
iceberg_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "stateful_ingestion": {"allOf": [{}]}, "adls": {"allOf": [{}]}, "localfs": {"type": "string"}, "max_path_depth": {"default": 2, "type": "integer"}, "table_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "user_ownership_property": {"default": "owner", "type": "string"}, "group_ownership_property": {"type": "string"}, "profiling": {"default": {"enabled": false, "include_field_null_count": true, "include_field_min_value": true, "include_field_max_value": true, "operation_config": {"lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null}}, "allOf": [{}]}}, "additionalProperties": false}
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
platform_instance
The instance of the platform that all assets produced by this recipe belong to
{"type": "string"}
datahub_ingestion_schema.json
stateful_ingestion
Iceberg Stateful Ingestion Config.
{"allOf": [{}]}
datahub_ingestion_schema.json
adls
[Azure Data Lake Storage](https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction) to crawl for Iceberg tables. This is one filesystem type supported by this source and **only one can be configured**.
{"allOf": [{}]}
datahub_ingestion_schema.json
localfs
Local path to crawl for Iceberg tables. This is one filesystem type supported by this source and **only one can be configured**.
{"type": "string"}
datahub_ingestion_schema.json
max_path_depth
Maximum folder depth to crawl for Iceberg tables. Folders deeper than this value will be silently ignored.
{"default": 2, "type": "integer"}
datahub_ingestion_schema.json
table_pattern
Regex patterns for tables to filter in ingestion.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
user_ownership_property
Iceberg table property to look for a `CorpUser` owner. Can only hold a single user value. If property has no value, no owner information will be emitted.
{"default": "owner", "type": "string"}
datahub_ingestion_schema.json
group_ownership_property
Iceberg table property to look for a `CorpGroup` owner. Can only hold a single group value. If property has no value, no owner information will be emitted.
{"type": "string"}
datahub_ingestion_schema.json
pulsar_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "stateful_ingestion": {"allOf": [{}]}, "web_service_url": {"default": "http://localhost:8080", "type": "string"}, "timeout": {"default": 5, "type": "integer"}, "issuer_url": {"type": "string"}, "client_id": {"type": "string"}, "client_secret": {"type": "string"}, "token": {"type": "string"}, "verify_ssl": {"default": true, "anyOf": [{"type": "boolean"}, {"type": "string"}]}, "tenant_patterns": {"default": {"allow": [".*"], "deny": ["pulsar"], "ignoreCase": true}, "allOf": [{}]}, "namespace_patterns": {"default": {"allow": [".*"], "deny": ["public/functions"], "ignoreCase": true}, "allOf": [{}]}, "topic_patterns": {"default": {"allow": [".*"], "deny": ["/__.*$"], "ignoreCase": true}, "allOf": [{}]}, "exclude_individual_partitions": {"default": true, "type": "boolean"}, "tenants": {"default": [], "type": "array", "items": {"type": "string"}}, "domain": {"type": "object", "additionalProperties": {}}, "oid_config": {"type": "object"}}, "additionalProperties": false}
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
platform_instance
The instance of the platform that all assets produced by this recipe belong to
{"type": "string"}
datahub_ingestion_schema.json
stateful_ingestion
see Stateful Ingestion
{"allOf": [{}]}
datahub_ingestion_schema.json
web_service_url
The web URL for the cluster.
{"default": "http://localhost:8080", "type": "string"}
datahub_ingestion_schema.json
timeout
Timout setting, how long to wait for the Pulsar rest api to send data before giving up
{"default": 5, "type": "integer"}
datahub_ingestion_schema.json
issuer_url
The complete URL for a Custom Authorization Server. Mandatory for OAuth based authentication.
{"type": "string"}
datahub_ingestion_schema.json
client_id
The application's client ID
{"type": "string"}
datahub_ingestion_schema.json
client_secret
The application's client secret
{"type": "string"}
datahub_ingestion_schema.json
token
The access token for the application. Mandatory for token based authentication.
{"type": "string"}
datahub_ingestion_schema.json
verify_ssl
Either a boolean, in which case it controls whether we verify the server's TLS certificate, or a string, in which case it must be a path to a CA bundle to use.
{"default": true, "anyOf": [{"type": "boolean"}, {"type": "string"}]}
datahub_ingestion_schema.json
tenant_patterns
List of regex patterns for tenants to include/exclude from ingestion. By default all tenants are allowed.
{"default": {"allow": [".*"], "deny": ["pulsar"], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
namespace_patterns
List of regex patterns for namespaces to include/exclude from ingestion. By default the functions namespace is denied.
{"default": {"allow": [".*"], "deny": ["public/functions"], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
topic_patterns
List of regex patterns for topics to include/exclude from ingestion. By default the Pulsar system topics are denied.
{"default": {"allow": [".*"], "deny": ["/__.*$"], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
exclude_individual_partitions
Extract each individual partitioned topic. e.g. when turned off a topic with 100 partitions will result in 100 Datasets.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
tenants
Listing all tenants requires superUser role, alternative you can set a list of tenants you want to scrape using the tenant admin role
{"default": [], "type": "array", "items": {"type": "string"}}
datahub_ingestion_schema.json
domain
Domain patterns
{"type": "object", "additionalProperties": {}}
datahub_ingestion_schema.json
oid_config
Placeholder for OpenId discovery document
{"type": "object"}
datahub_ingestion_schema.json
delta-lake_config
Any source that connects to a platform should inherit this class
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "base_path": {"type": "string"}, "relative_path": {"type": "string"}, "platform": {"default": "delta-lake", "const": "delta-lake", "type": "string"}, "table_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "version_history_lookback": {"default": 1, "type": "integer"}, "require_files": {"default": true, "type": "boolean"}, "s3": {}}, "required": ["base_path"], "additionalProperties": false}
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
platform_instance
The instance of the platform that all assets produced by this recipe belong to
{"type": "string"}
datahub_ingestion_schema.json
base_path
Path to table (s3 or local file system). If path is not a delta table path then all subfolders will be scanned to detect and ingest delta tables.
{"type": "string"}
datahub_ingestion_schema.json
relative_path
If set, delta-tables will be searched at location '<base_path>/<relative_path>' and URNs will be created using relative_path only.
{"type": "string"}
datahub_ingestion_schema.json
platform
The platform that this source connects to
{"default": "delta-lake", "const": "delta-lake", "type": "string"}
datahub_ingestion_schema.json
table_pattern
regex patterns for tables to filter in ingestion.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
version_history_lookback
Number of previous version histories to be ingested. Defaults to 1. If set to -1 all version history will be ingested.
{"default": 1, "type": "integer"}
datahub_ingestion_schema.json
require_files
Whether DeltaTable should track files. Consider setting this to `False` for large delta tables, resulting in significant memory reduction for ingestion process.When set to `False`, number_of_files in delta table can not be reported.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
azure-ad_config
Config to create a token and connect to Azure AD instance
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "stateful_ingestion": {"allOf": [{}]}, "client_id": {"type": "string"}, "tenant_id": {"type": "string"}, "client_secret": {"type": "string"}, "authority": {"type": "string"}, "token_url": {"type": "string"}, "redirect": {"default": "https://login.microsoftonline.com/common/oauth2/nativeclient", "type": "string"}, "graph_url": {"default": "https://graph.microsoft.com/v1.0", "type": "string"}, "azure_ad_response_to_username_attr": {"default": "userPrincipalName", "type": "string"}, "azure_ad_response_to_username_regex": {"default": "(.*)", "type": "string"}, "azure_ad_response_to_groupname_attr": {"default": "displayName", "type": "string"}, "azure_ad_response_to_groupname_regex": {"default": "(.*)", "type": "string"}, "ingest_users": {"default": true, "type": "boolean"}, "ingest_groups": {"default": true, "type": "boolean"}, "ingest_group_membership": {"default": true, "type": "boolean"}, "ingest_groups_users": {"default": true, "type": "boolean"}, "users_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "groups_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "filtered_tracking": {"default": true, "type": "boolean"}, "mask_group_id": {"default": true, "type": "boolean"}, "mask_user_id": {"default": true, "type": "boolean"}}, "required": ["client_id", "tenant_id", "client_secret", "authority", "token_url"], "additionalProperties": false}
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
platform_instance
The instance of the platform that all assets produced by this recipe belong to
{"type": "string"}
datahub_ingestion_schema.json
stateful_ingestion
Azure AD Stateful Ingestion Config.
{"allOf": [{}]}
datahub_ingestion_schema.json
client_id
Application ID. Found in your app registration on Azure AD Portal
{"type": "string"}
datahub_ingestion_schema.json
tenant_id
Directory ID. Found in your app registration on Azure AD Portal
{"type": "string"}
datahub_ingestion_schema.json
client_secret
Client secret. Found in your app registration on Azure AD Portal
{"type": "string"}
datahub_ingestion_schema.json
authority
The 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.
{"type": "string"}
datahub_ingestion_schema.json
token_url
The token URL that acquires a token from Azure AD for authorizing requests. This source will only work with v1.0 endpoint.
{"type": "string"}
datahub_ingestion_schema.json
redirect
Redirect URI. Found in your app registration on Azure AD Portal.
{"default": "https://login.microsoftonline.com/common/oauth2/nativeclient", "type": "string"}
datahub_ingestion_schema.json
graph_url
[Microsoft Graph API endpoint](https://docs.microsoft.com/en-us/graph/use-the-api)
{"default": "https://graph.microsoft.com/v1.0", "type": "string"}
datahub_ingestion_schema.json
azure_ad_response_to_username_attr
Which Azure AD User Response attribute to use as input to DataHub username mapping.
{"default": "userPrincipalName", "type": "string"}
datahub_ingestion_schema.json
azure_ad_response_to_username_regex
A regex used to parse the DataHub username from the attribute specified in `azure_ad_response_to_username_attr`.
{"default": "(.*)", "type": "string"}
datahub_ingestion_schema.json
azure_ad_response_to_groupname_attr
Which Azure AD Group Response attribute to use as input to DataHub group name mapping.
{"default": "displayName", "type": "string"}
datahub_ingestion_schema.json
azure_ad_response_to_groupname_regex
A regex used to parse the DataHub group name from the attribute specified in `azure_ad_response_to_groupname_attr`.
{"default": "(.*)", "type": "string"}