Skip to main content

Policies Guide

Introduction

DataHub provides the ability to declare fine-grained access control Policies via the UI & GraphQL API. Access policies in DataHub define who can do what to which resources. A few policies in plain English include

  • Dataset Owners should be allowed to edit documentation, but not Tags.
  • Jenny, our Data Steward, should be allowed to edit Tags for any Dashboard, but no other metadata.
  • James, a Data Analyst, should be allowed to edit the Links for a specific Data Pipeline he is a downstream consumer of.
  • The Data Platform team should be allowed to manage users & groups, view platform analytics, & manage policies themselves.

In this document, we'll take a deeper look at DataHub Policies & how to use them effectively.

What is a Policy?

There are 2 types of Policy within DataHub:

  1. Platform Policies
  2. Metadata Policies

We'll briefly describe each.

Platform Policies

Platform policies determine who has platform-level privileges on DataHub. These privileges include

  • Managing Users & Groups
  • Viewing the DataHub Analytics Page
  • Managing Policies themselves

Platform policies can be broken down into 2 parts:

  1. Actors: Who the policy applies to (Users or Groups)
  2. Privileges: Which privileges should be assigned to the Actors (e.g. "View Analytics")

Note that platform policies do not include a specific "target resource" against which the Policies apply. Instead, they simply serve to assign specific privileges to DataHub users and groups.

Metadata Policies

Metadata policies determine who can do what to which Metadata Entities. For example,

  • Who can edit Dataset Documentation & Links?
  • Who can add Owners to a Chart?
  • Who can add Tags to a Dashboard?

and so on.

A Metadata Policy can be broken down into 3 parts:

  1. Resources: The 'which'. Resources that the policy applies to, e.g. "All Datasets".
  2. Privileges: The 'what'. What actions are being permitted by a policy, e.g. "Add Tags".
  3. Actors: The 'who'. Specific users, groups that the policy applies to.

Resources

Resources can be associated with the policy in a number of ways:

  1. Resource types - The entity's type, for example: dataset, chart, dashboard
  2. Resource URNs - Specific entity URNs to target
  3. Tags - Assets tagged with specific tags
  4. Domains - Assets within specific domains
  5. Containers - Assets within specific containers (e.g., databases, schemas)
  6. Glossary Terms or Term Groups - Assets annotated with specific glossary terms or any term within a term group (see Glossary-Based Policy Targeting below)
Important Note

The associations in the list above are an intersection or an AND operation. For example, if the policy targets 1. resource type: dataset and 3. resources tagged: 'myTag', it will apply to datasets that are tagged with tag 'myTag'.

Domain-Based Policy Targeting

Policies can be targeted to assets based on Domains. This allows you to apply permissions to all assets within a specific business domain.

When you target a policy by domain, the policy applies recursively to any asset that belongs to that domain as well as any assets in nested child domains.

Example: A policy targeting the "Marketing" domain will apply to all datasets, dashboards, and other assets assigned to that domain, as well as assets in child domains like "Marketing Analytics" or "Marketing Campaigns".

View-based access control performance

When view-based access control is enabled, domain filters can be expensive: DataHub walks the domain hierarchy for each authorization check. Prefer ownership-based policies for entity access, and use domain filters mainly for domain-entity visibility or Cloud discovery boundaries. Keep domain hierarchies shallow.

Container-Based Policy Targeting

Policies can be targeted to assets based on Containers (e.g., databases, schemas, projects). This allows you to apply permissions based on technical organization.

When you target a policy by container, the policy applies recursively to all assets within that container as well as any assets in nested child containers.

Example: A policy targeting a "production" database container will apply to all schemas within that database and all tables within those schemas.

View-based access control performance

When view-based access control is enabled, container filters walk the container hierarchy sequentially for each authorization check. Avoid container-based policies on deep warehouse hierarchies (database → schema → table). See Domains and containers for alternatives.

Glossary-Based Policy Targeting

Policies can be targeted to assets based on Glossary Terms or Glossary Term Groups. This allows you to apply permissions based on business vocabulary rather than technical properties.

When you target a policy by glossary terms or groups:

  • Individual Terms: The policy applies to any asset annotated with that specific glossary term
  • Term Groups: The policy applies recursively to assets annotated with any term within that group, including all nested child terms and groups

This works similarly to domain and container-based policies, automatically covering assets as your glossary evolves.

Example: A policy targeting the "Sensitive Data" term group will apply to all assets tagged with child terms like "PII", "PHI", or any terms in nested groups, without requiring policy updates when new terms are added to the hierarchy.

Privileges

Check out the list of privileges here . Note, the privileges are semantic by nature, and does not tie in 1-to-1 with the aspect model.

All edits on the UI are covered by a privilege, to make sure we have the ability to restrict write access. See the Reference section below.

Actors

We currently support 3 ways to define the set of actors the policy applies to:

  1. list of users (or all users)
  2. list of groups (or all groups)
  3. owners of the entity
Important Note

Unlike resources, the definitions for actors are a union of the actors. For example, if user 1. Alice is associated with the policy as well as 3. owners of the entity. This means that Alice OR any owner of the targeted resource(s) will be included in the policy.

Managing Policies

Policies can be managed on the page Settings > Permissions > Policies page. The Policies tab will only be visible to those users having the Manage Policies privilege.

Out of the box, DataHub is deployed with a set of pre-baked Policies. The set of default policies are created at deploy time and can be found inside the policies.json file within metadata-service/war/src/main/resources/boot. This set of policies serves the following purposes:

  1. Assigns immutable super-user privileges for the root datahub user account (Immutable)
  2. Assigns all Platform privileges for all Users by default (Editable)

The reason for #1 is to prevent people from accidentally deleting all policies and getting locked out (datahub super user account can be a backup) The reason for #2 is to permit administrators to log in via OIDC or another means outside of the datahub root account when they are bootstrapping with DataHub. This way, those setting up DataHub can start managing policies without friction. Note that these privilege can and likely should be altered inside the Policies page of the UI.

Pro-Tip

To login using the datahub account, simply navigate to <your-datahub-domain>/login and enter datahub, datahub. Note that the password can be customized for your deployment by changing the user.props file within the datahub-frontend module. Notice that JaaS authentication must be enabled.

Configuration

By default, the Policies feature is enabled. This means that the deployment will support creating, editing, removing, and most importantly enforcing fine-grained access policies.

In some cases, these capabilities are not desirable. For example, if your company's users are already used to having free reign, you may want to keep it that way. Or perhaps it is only your Data Platform team who actively uses DataHub, in which case Policies may be overkill.

For these scenarios, we've provided a back door to disable Policies in your deployment of DataHub. This will completely hide the policies management UI and by default will allow all actions on the platform. It will be as though each user has all privileges, both of the Platform & Metadata flavor.

To disable Policies, you can simply set the AUTH_POLICIES_ENABLED environment variable for the datahub-gms service container to false. For example in your docker/datahub-gms/docker.env, you'd place

AUTH_POLICIES_ENABLED=false

REST API Authorization

Policies only affect REST APIs when the environment variable REST_API_AUTHORIZATION is set to true for GMS. Some policies only apply when this setting is enabled, marked above, and other Metadata and Platform policies apply to the APIs where relevant, also specified in the table above.

Designing policies for view-based access control

This section covers how to design access policies when view-based access control (VBAC) is enabled — that is, when policies restrict what users can view or discover, not just edit. Poor policy design in VBAC deployments can cause slow search, slow entity pages, and high load on the metadata service.

When this guidance applies

DeploymentVBAC prerequisiteWhat it enables
DataHub CloudSearch Access Controls enabledView Entity privilege; search results filtered at query time
Self-hosted (OSS)VIEW_AUTHORIZATION_ENABLED=true on GMSView Entity Page privilege; entity page gating and optional post-search result masking — not Elasticsearch query pushdown

Performance considerations

Policy evaluation is grant-only and first-match-wins: DataHub checks policies in order until one grants access. Under VBAC, view and discovery privileges trigger authorization on search results, entity pages, and browse — often once per entity.

Keep these factors in mind when designing policies:

FactorImpactRecommendation
Number of active policiesEvery user session evaluates actor match against all policies; each authorization request may iterate policies until one grants accessConsolidate policies; avoid duplicating the same privilege across many policies
Domain resource filtersEach check may walk the full domain parent hierarchyPrefer ownership for entity access; keep domain trees shallow; use domain filters for domain entities or Cloud discovery only
Container resource filtersEach check walks the container chain (database → schema → table)Avoid container-based view policies on deep hierarchies
Group membershipUsers in many groups increase matching and role-resolution costOne group per team policy boundary; avoid listing many groups on a single policy
Search under VBACEach search hit may be authorized individually with full policy evaluationFewer domain-scoped view policies; prefer ownership-based grants
Policy cachePolicy changes may take up to ~120 seconds to propagate (POLICY_CACHE_REFRESH_INTERVAL_SECONDS)Plan for brief delay after policy updates

Groups

Groups are the preferred way to assign policies to teams. When VBAC is enabled:

  • Sync from your IdP when possible (Okta, Azure AD) so group membership stays current without manual updates.
  • Assign one group per policy boundary — e.g. a "Team A Developers" group on a single owner-based policy, rather than listing many groups on one policy.
  • Limit overlapping group membership — users in many groups increase authorization cost, especially when policies match on roles derived from group membership.
  • Prefer group-level policies over per-user policies — easier to maintain and fewer actor entries to evaluate.

For SCIM-based group provisioning, see Okta identity provisioning and Microsoft Entra identity provisioning.

Domains and containers

Domains organize metadata for curation; they can also be used as policy resource filters. Under VBAC, using domains as the primary boundary for entity view access is expensive because DataHub resolves parent domains recursively on every authorization check.

Prefer:

  • Ownership-based policies for dataset and other entity access (see Ownership-based access)
  • Domain filters only for domain entity visibility (so users can navigate the domain tree) or for Cloud Search Access Controls discovery boundaries
  • Shallow domain hierarchies when domain filters are required

Avoid:

  • One full-metadata view policy per team domain when ownership can express the same boundary
  • Deep nested domain trees as the primary access boundary
  • Container-based view policies on deep warehouse hierarchies

Roles and VBAC

When VBAC is enabled, Admin, Editor, and Reader roles override view-based policy restrictions. Users assigned any of these roles can view all entities regardless of domain- or ownership-based view policies.

Do not assign Editor or Reader to users who should have restricted discovery. Reserve the Admin role for platform operators. See Roles and Search Access Controls.

These patterns assume VBAC is enabled and separate teams need isolated metadata visibility. Use generic team and domain names when implementing.

Pattern A — Multi-team isolation (ownership-first)

Use when separate teams or business units should only access their own metadata:

  1. Platform AdminsAdmin role only (hardcoded super-privileges).
  2. Central platform team — one metadata policy: actors = IdP group(s), resources = broad (by entity type), privileges = view/edit as needed.
  3. Team-scoped users — one owner-based metadata policy per team: actors = resource owners (group ownership type), privileges include view/edit metadata; assign ownership at ingestion (see Ownership-based access).
  4. Domain visibility only — one narrow policy per team targeting domain entities (not datasets) so users can navigate the domain structure without domain-scoped dataset policies.

Resource matching via ownership uses a single ownership aspect fetch instead of walking domain parents on every dataset.

Pattern B — Domain-scoped discovery (DataHub Cloud)

On DataHub Cloud with Search Access Controls enabled:

  • Use domain-based View Entity policies for discovery boundaries.
  • Keep the domain hierarchy shallow, policy count low, and do not assign Editor/Reader roles to restricted users.

Anti-patterns

  • One policy per user instead of per group.
  • Many overlapping domain policies for the same privilege (e.g. one full-metadata policy per team domain instead of consolidating).
  • Deep nested domain trees as the primary access boundary.
  • Container-based policies on deep database → schema → table chains.
  • Assigning Reader or Editor while expecting domain or ownership isolation.
  • Relying on OSS VIEW_AUTHORIZATION_ENABLED alone to prevent users from discovering other teams' data in search (OSS does not filter search at query time).
  • Large numbers of URN-specific policies instead of tags plus one tag-based policy.

Ownership-based access

Assign ownership at ingestion so owner-based policies can grant view and edit access without domain-scoped resource filters. Use the pattern_add_dataset_ownership transformer to match dataset URNs and assign group owners by pattern.

Schema ownership: Ingestion recipes that assign ownership only to datasets may leave schemas without owners. If team-scoped users need to view schemas via owner-based policies, assign schema ownership through the UI or extend ingestion to cover schema entities.

Troubleshooting slow search or UI

If search or entity pages feel slow after enabling VBAC:

  1. Count active policies — reduce overlapping or redundant policies.
  2. Review domain-scoped view policies — replace dataset boundaries with ownership-based policies where possible.
  3. Check domain depth — flatten nested domains used in policy filters.
  4. Review group membership — reduce users in many overlapping groups.
  5. Check role assignments — Editor/Reader on restricted users won't cause slowness but indicates misconfiguration if isolation is expected.
  6. Wait for cache refresh — policy changes may take up to POLICY_CACHE_REFRESH_INTERVAL_SECONDS (default 120) to apply.

Policy propagation

Policy definitions are cached in GMS and refreshed periodically. After creating or editing policies, allow up to POLICY_CACHE_REFRESH_INTERVAL_SECONDS seconds (default 120) before changes fully propagate. See environment variables for configuration.

Reference

For a complete list of privileges see the privileges here.

Platform-level privileges

These privileges are for DataHub operators to access & manage the administrative functionality of the system.

Access & Credentials

Platform PrivilegesDescription
Generate Personal Access TokensAllow actor to generate personal access tokens for use with DataHub APIs.
Manage PoliciesAllow actor to create and remove access control policies. Be careful - Actors with this privilege are effectively super users.
Manage SecretsAllow actor to create & remove Secrets stored inside DataHub.
Manage Users & GroupsAllow actor to create, remove, and update users and groups on DataHub.
Manage All Access TokensAllow actor to create, list and revoke access tokens on behalf of users in DataHub. Be careful - Actors with this privilege are effectively super users that can impersonate other users.
Manage User CredentialsAllow actor to manage credentials for native DataHub users, including inviting new users and resetting passwords
Manage ConnectionsAllow actor to manage connections to external DataHub platforms.

Product Features

Platform PrivilegesDescription
Manage Home Page PostsAllow actor to create and delete home page posts
Manage Business AttributeAllow actor to create, update, delete Business Attribute
Manage Documentation FormsAllow actor to manage forms assigned to assets to assist in documentation efforts.
Manage Metadata IngestionAllow actor to create, remove, and update Metadata Ingestion sources.
Manage FeaturesUmbrella privilege to manage all features.
View AnalyticsAllow actor to view the DataHub analytics dashboard.
Manage Public ViewsAllow actor to create, update, and delete any Public (shared) Views.
Manage Ownership TypesAllow actor to create, update and delete Ownership Types.
Create Business AttributeAllow actor to create new Business Attribute.
Manage Structured PropertiesManage structured properties in your instance.
View TestsView Asset Tests.
Manage Tests1Allow actor to create and remove Asset Tests.
View Metadata Proposals1Allow actor to view the requests tab for viewing metadata proposals.
Create metadata constraints2Allow actor to create metadata constraints.
Manage Platform Settings1Allow actor to view and change platform-level settings, like integrations & notifications.
Manage Monitors1Allow actor to create, update, and delete any data asset monitors, including Custom SQL monitors. Grant with care.
View Manage TagsAllow the actor to view the Manage Tags page.

Entity Management

Platform PrivilegesDescription
Manage DomainsAllow actor to create and remove Asset Domains.
Manage GlossariesAllow actor to create, edit, and remove Glossary Entities
Manage TagsAllow actor to create and remove Tags.

System Management

Platform PrivilegesDescription
Restore Indices API3Allow actor to use the Restore Indices API.
Get Timeseries index sizes API3Allow actor to use the get Timeseries indices size API.
Truncate timeseries aspect index size API3Allow actor to use the API to truncate a timeseries index.
Get ES task status API3Allow actor to use the get task status API for an ElasticSearch task.
Enable/Disable Writeability API3Allow actor to enable or disable GMS writeability for data migrations.
Apply Retention API3Allow actor to apply retention using the API.
Analytics API access3Allow actor to use API read access to raw analytics data.
Explain ElasticSearch Query API3Allow actor to use the Operations API explain endpoint.
Produce Platform Event API3Allow actor to produce Platform Events using the API.
Manage System OperationsAllow actor to manage system operation controls. This setting includes all System Management privileges.

Common Metadata Privileges

These privileges are to view & modify any entity within DataHub.

Entity Privileges

Entity PrivilegesDescription
View Entity PageAllow actor to view the entity page.
Edit EntityAllow actor to edit any information about an entity. Super user privileges for the entity.
DeleteAllow actor to delete this entity.
Create EntityAllow actor to create an entity if it doesn't exist.
Entity ExistsAllow actor to determine whether the entity exists.
Execute EntityAllow actor to execute entity ingestion.
Get Timeline API3Allow actor to use the GET Timeline API.
Get Entity + Relationships API3Allow actor to use the GET Entity and Relationships API.
Get Aspect/Entity Count APIs3Allow actor to use the GET Aspect/Entity Count APIs.
View Entity1Allow actor to view the entity in search results. This privilege can be explicitly granted, but is also implied by the View Entity Page privilege.
Share Entity1Allow actor to share an entity with another DataHub Cloud instance.

Aspect Privileges

Aspect PrivilegesDescription
Edit TagsAllow actor to add and remove tags to an asset.
Edit Glossary TermsAllow actor to add and remove glossary terms to an asset.
Edit DescriptionAllow actor to edit the description (documentation) of an entity.
Edit LinksAllow actor to edit links associated with an entity.
Edit StatusAllow actor to edit the status of an entity (soft deleted or not).
Edit DomainAllow actor to edit the Domain of an entity.
Edit Data ProductAllow actor to add or remove Data Product membership from an asset (asset profile / batchAddToDataProducts, batchRemoveFromDataProducts, unset via batchSetDataProduct). Does not authorize editing a Data Product's assets list from the product page — see Manage Data Products.
Edit DeprecationAllow actor to edit the Deprecation status of an entity.
Edit IncidentsAllow actor to create and remove incidents for an entity.
Edit LineageAllow actor to add and remove lineage edges for this entity.
Edit PropertiesAllow actor to edit the properties for an entity.
Edit OwnersAllow actor to add and remove owners of an entity.
Get Timeseries Aspect API3Allow actor to use the GET Timeseries Aspect API.

Proposals

Proposals PrivilegesDescription
Propose Tags1Allow actor to propose adding a tag to an asset.
Propose Glossary Terms1Allow actor to propose adding a glossary term to an asset.
Propose Owners1Allow actor to propose adding an owner to an asset.
Propose Domains1Allow actor to propose adding a domain to an asset.
Propose Data Contract1Allow actor to propose adding a data contract to a dataset.
Propose Structured properties1Allow actor to propose adding a structured property to an asset.
Propose Documentation1Allow actor to propose updates to an asset's documentation.
Propose Dataset Column Glossary Terms1Allow actor to propose a glossary term to a dataset schema column (field).
Propose Dataset Column Tags1Allow actor to propose a tag to a dataset schema column (field).
Propose Dataset Column Descriptions1Allow actor to propose a updates to dataset's schema column (field) description
Propose Dataset Column Structured Properties1Allow actor to propose a structured property to a dataset schema column (field).
Propose Create Glossary Term1Allow actor to propose creation of a new glossary term.
Propose Create Glossary Node1Allow actor to propose creation of a new glossary node.
Manage Tag Proposals1Allow actor to manage a proposal to add a tag to an asset.
Manage Glossary Term Proposals1Allow actor to manage a proposal to add a glossary term to an asset.
Manage Domain Proposals1Allow actor to manage a proposal to add a domain to an asset.
Manage Owner Proposals1Allow actor to manage a proposal to add an owner to an asset.
Manage Property Proposals1Allow actor to manage a proposal to add a structured property to an asset.
Manage Data Contract Proposals1Allow actor to manage a proposal to add a data contract to a dataset.
Manage Documentation Proposals1Allow actor to manage updates to asset's documentation.
Manage Dataset Column Tag Proposals1Allow actor to manage a proposal to add a tag to dataset schema field (column).
Manage Dataset Column Glossary Term Proposals1Allow actor to manage a proposal to add a glossary term to dataset schema field (column).
Manage Dataset Column Property Proposals1Allow actor to manage a proposal to add a structured property to dataset schema field (column).

Derived authorization rules

Some APIs authorize against related entities rather than only the URN in the request. These rules apply across GraphQL, Rest.li, and MCP ingestion (unless the change uses a system ingestion source).

Data Products

OperationPrivilege evaluatedResource
Create Data ProductManage Data ProductsDomain from create input
Update / delete Data ProductManage Data ProductsAt least one Domain on the product
Change dataProductProperties.assets (MCP / ingestion)Manage Data Products on any product Domain or Edit Data Product on every changed assetProduct Domain(s) and/or each changed asset
Change dataProductProperties.assets (product page / batchSetDataProduct with urn)Manage Data ProductsAt least one Domain on the product
Add/remove Data Product from asset profileEdit Data ProductTarget asset
Rename Data Product (updateName)Manage Data Products on any Domain or Edit Entity on the Data ProductDomains and/or product URN

Domain URNs are read from the product's domains aspect, preferring domainAssociations and falling back to the legacy domains array. Duplicate entries are deduplicated. Products with no Domain associations are denied for product-side manage operations. Product and asset Domains do not need to match — authorization succeeds when either product-side manage or asset-side edit checks pass.

Known issue: Domain alignment is not enforced after membership is written. Changing a product's or asset's domains aspect does not re-validate or prune existing assets links.

Query entities

OperationPrivilege evaluatedResource
Create / update / delete QueryEdit Dataset Queries (or Edit Entity)Each subject dataset in querySubjects
Read Query metadata (GraphQL, Rest.li, search when view auth is on)View Entity Page or Edit Dataset QueriesEvery subject dataset in querySubjects

Query entities with no subjects are not readable when view authorization is enabled (fail-closed). Schema field subjects are resolved to their parent dataset for authorization. Edit Entity on a subject dataset also grants read access (same disjunction as write).

View authorization is controlled by VIEW_AUTHORIZATION_ENABLED (see Environment Variables).

Logical parent (logicalParent aspect)

Setting a logical parent requires Edit Entity on both the child and the proposed parent. Clearing a logical parent requires Edit Entity on the child side only. There is no OR between child and parent — access to only one side is insufficient when setting a link.

Each side is evaluated independently. For a dataset, that side passes when the actor has Edit Entity on that dataset. For a schema field, that side passes when the actor has Edit Entity on the containing dataset or on the schema field URN. Child and parent may satisfy their respective checks via different grant types (for example, dataset grant on the physical side and schema-field grant on the logical side).

Child entityParent entity (when set)How access is evaluated
datasetdatasetEdit Entity on child dataset and parent dataset
schemaFieldschemaFieldEdit Entity on each side (containing dataset or schema field URN), independently
datasetschemaFieldEdit Entity on child dataset and on parent (containing dataset or schema field URN)
schemaFielddatasetEdit Entity on child (containing dataset or schema field URN) and parent dataset

Applies to MCP ingestion, GraphQL (setLogicalParent), and OpenAPI logical-model relationship endpoints.

Specific Entity-level Privileges

These privileges are not generalizable.

Users & Groups

EntityPrivilegeDescription
GroupEdit Group MembersAllow actor to add and remove members to a group.
GroupManage Group Notification Settings1Allow actor to manage notification settings for a group.
GroupManage Group Subscriptions1Allow actor to manage subscriptions for a group.
GroupEdit Contact InformationAllow actor to change the contact information such as email & chat handles.
UserEdit Contact InformationAllow actor to change the contact information such as email & chat handles.
UserEdit User ProfileAllow actor to change the user's profile including display name, bio, title, profile image, etc.

Dataset

EntityPrivilegeDescription
DatasetView Dataset UsageAllow actor to access dataset usage information (includes usage statistics and queries).
DatasetView Dataset ProfileAllow actor to access dataset profile (snapshot statistics)
DatasetEdit Dataset Column DescriptionsAllow actor to edit the column (field) descriptions associated with a dataset schema.
DatasetEdit Dataset Column TagsAllow actor to edit the column (field) tags associated with a dataset schema.
DatasetEdit Dataset Column Glossary TermsAllow actor to edit the column (field) glossary terms associated with a dataset schema.
DatasetEdit Dataset Column PropertiesAllow actor to edit the column (field) properties associated with a dataset schema.
DatasetPropose Dataset Column Glossary Terms1Allow actor to propose column (field) glossary terms associated with a dataset schema.
DatasetPropose Dataset Column Tags1Allow actor to propose new column (field) tags associated with a dataset schema.
DatasetManage Dataset Column Glossary Terms1Allow actor to manage column (field) glossary term proposals associated with a dataset schema.
DatasetPropose Dataset Column Descriptions1Allow actor to propose new descriptions associated with a dataset schema.
DatasetManage Dataset Column Tag Proposals1Allow actor to manage column (field) tag proposals associated with a dataset schema.
DatasetEdit AssertionsAllow actor to add and remove assertions from an entity.
DatasetEdit Dataset QueriesAllow actor to edit the Queries for a Dataset. Query entity read visibility is derived from View Entity Page or Edit Dataset Queries (or Edit Entity) on all subject datasets linked via querySubjects.
DatasetView Dataset OperationsAllow actor to view operations on a Dataset.
DatasetCreate erModelRelationshipAllow actor to add erModelRelationship on a dataset.
DatasetEdit Monitors1Allow actor to edit monitors for the entity.
DatasetEdit SQL Assertion Monitors1Allow actor to edit custom SQL assertion monitors for the entity. Note that this gives read query access to users with through the Custom SQL assertion builder. Grant with care.
DatasetEdit Data Contract1Allow actor to edit the Data Contract for an entity.
DatasetManage Data Contract Proposals1Allow actor to manage a proposal for a Data Contract
TagEdit Tag ColorAllow actor to change the color of a Tag.
DomainManage Data ProductsAllow actor to create, update, and delete Data Products scoped to a Domain, including changing a product's assets membership from the product side when the actor has this privilege on at least one Domain associated with the product.
GlossaryNodeManage Direct Glossary ChildrenAllow actor to create and delete the direct children of this entity.
GlossaryNodeManage All Glossary ChildrenAllow actor to create and delete everything underneath this entity.

Misc

EntityPrivilegeDescription
TagEdit Tag ColorAllow actor to change the color of a Tag.
DomainManage Data ProductsAllow actor to create, update, and delete Data Products scoped to a Domain, including changing a product's assets membership from the product side when the actor has this privilege on at least one Domain associated with the product.
GlossaryNodeManage Direct Glossary ChildrenAllow actor to create and delete the direct children of this entity.
GlossaryNodeManage All Glossary ChildrenAllow actor to create and delete everything underneath this entity.

Coming Soon

Experimental

Support for Policy Constraints based on entity sub-resources (tags, glossary terms, domains, containers, etc.) is currently in development and in an experimental phase.

Currently the only supported sub-resources are tags. These are supported through an additional parameter in DataHubPolicyInfo which is currently only modifiable via API, there is no UI option to configure it. Specifically the option is privilegeConstraints which takes a PolicyMatchFilter within the existing DataHubResourceFilter for a policy. This works similarly to the existing resource filter, but instead of applying to the main entity being acted on it applies to the subResource targeted in the action. For example, if the policy specifies it is constrained to tags that equal urn:li:tag:tag1 or urn:li:tag:tag2 for EDIT_DATASET_TAGS privilege, then assuming no other policies match, a user would only be able to apply those tags to the dataset. This is also supported with the NOT_EQUALS condition for preventing certain tags from being added/removed. These policies apply by default in the UI and can be configured to apply to API operations as well through the MCP_VALIDATION_PRIVILEGE_CONSTRAINTS environment variable which should be applied globally (GMS, MCE Consumer, and DataHub Upgrade specifically), which is enabled by default.

Example JSON of a policy with constraints:

{
"actors": {
"resourceOwners": false,
"groups": [],
"allGroups": false,
"allUsers": false,
"users": ["urn:li:corpuser:ryan@email.com"]
},
"lastUpdatedTimestamp": 0,
"privileges": ["EDIT_ENTITY_TAGS", "EDIT_DATASET_COL_TAGS"],
"editable": true,
"displayName": "Ryan Policy",
"resources": {
"filter": { "criteria": [] },
"allResources": false,
"privilegeConstraints": {
"criteria": [
{
"field": "URN",
"condition": "EQUALS",
"values": ["urn:li:tag:PII", "urn:li:tag:Business Critical"]
}
]
}
},
"description": "",
"state": "ACTIVE",
"type": "METADATA"
}
mutation {
createPolicy(
input: {
type: METADATA
name: "my-policy"
state: ACTIVE
description: "My policy"
privileges: ["EDIT_ENTITY_TAGS"]
actors: {
allUsers: true
users: []
groups: []
resourceOwners: true
allGroups: true
}
resources: {
allResources: true
resources: []
filter: { criteria: [] }
policyConstraints: {
criteria: [
{
field: "URN"
values: ["urn:li:tag:PII", "urn:li:tag:Business Critical"]
condition: EQUALS
}
]
}
}
}
)
}

Feedback / Questions / Concerns

We want to hear from you! For any inquiries, including Feedback, Questions, or Concerns, reach out on Slack!


  1. DataHub Cloud only
  2. Deprecated feature
  3. Only active if REST_API_AUTHORIZATION_ENABLED is true