mirror of
https://github.com/datahub-project/datahub.git
synced 2025-11-30 04:34:34 +00:00
100 lines
62 KiB
HTML
100 lines
62 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-docs/authorization/roles" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.3">
|
||
<title data-rh="true">Roles | DataHub</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.datahub.com/docs/authorization/roles"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Roles | DataHub"><meta data-rh="true" name="description" content="DataHub provides the ability to use Roles to manage permissions."><meta data-rh="true" property="og:description" content="DataHub provides the ability to use Roles to manage permissions."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.datahub.com/docs/authorization/roles"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/authorization/roles" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.datahub.com/docs/authorization/roles" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://RK0UG797F3-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/learn/rss.xml" title="DataHub RSS Feed">
|
||
<link rel="alternate" type="application/atom+xml" href="/learn/atom.xml" title="DataHub Atom Feed">
|
||
|
||
<link rel="preconnect" href="https://www.google-analytics.com">
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script async src="https://www.googletagmanager.com/gtag/js?id=G-PKGVLETT4C"></script>
|
||
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-PKGVLETT4C",{})</script>
|
||
<link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script>window.dataLayer=window.dataLayer||[]</script>
|
||
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-5M8T9HNN",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script>
|
||
|
||
|
||
<link rel="search" type="application/opensearchdescription+xml" title="DataHub" href="/opensearch.xml">
|
||
|
||
|
||
|
||
|
||
<meta httpequiv="Content-Security-Policy" content="frame-ancestors 'self' https://*.acryl.io https://acryldata.io http://localhost:*">
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Manrope:wght@400;500;700&display=swap">
|
||
<script src="https://tools.luckyorange.com/core/lo.js?site-id=28ea8a38" async defer="defer"></script>
|
||
<script src="/scripts/rb2b.js" async defer="defer"></script>
|
||
<script src="https://app.revenuehero.io/scheduler.min.js"></script>
|
||
<script src="https://tag.clearbitscripts.com/v1/pk_2e321cabe30432a5c44c0424781aa35f/tags.js" referrerpolicy="strict-origin-when-cross-origin"></script>
|
||
<script src="/scripts/reo.js"></script>
|
||
<script id="runllm-widget-script" type="module" src="https://widget.runllm.com" crossorigin="true" runllm-name="DataHub" runllm-assistant-id="81" runllm-position="BOTTOM_RIGHT" runllm-keyboard-shortcut="Mod+j" runllm-preset="docusaurus" runllm-theme-color="#1890FF" runllm-brand-logo="https://docs.datahub.com/img/datahub-logo-color-mark.svg" runllm-community-url="https://datahub.com/slack" runllm-community-type="slack" runllm-disable-ask-a-person="true" async></script><link rel="stylesheet" href="/assets/css/styles.1e47f27f.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.07cf073e.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.60e11739.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5M8T9HNN" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus">
|
||
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="announcementBar_mb4j" style="background-color:transparent;color:#ffffff" role="banner"><div class="content_knG7 announcementBarContent_xLdY"><div class="shimmer-banner"><p><strong>CONTEXT:</strong> December Town Hall 12/2</p><a href="https://events.datahub.com/december-townhall-2025/?utm_term=docs" target="_blank" class="button"><div>Register<span> →</span></div></a></div></div></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a href="https://datahub.com" target="_blank" rel="noopener noreferrer" class="navbar__brand"><div class="navbar__logo"><img src="/img/datahub-logo-color-light-horizontal.svg" alt="DataHub Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/datahub-logo-color-dark-horizontal.svg" alt="DataHub Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link versionNavItem_cbn8">Next</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/authorization/roles">Next</a></li><li><a class="dropdown__link" href="/docs/1.3.0/authorization/roles">1.3.0</a></li><li><hr class="dropdown-separator" style="margin: 0.4rem;"></li><li><div class="dropdown__link"><b>Archived versions</b></div></li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/features">1.0.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-t9sv4w3gr-acryldata.vercel.app/docs/0.15.0/features">0.15.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-8jkm4uler-acryldata.vercel.app/docs/0.14.1/features">0.14.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-eue2qafvn-acryldata.vercel.app/docs/features">0.14.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-psat3nzgi-acryldata.vercel.app/docs/features">0.13.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-lzxh86531-acryldata.vercel.app/docs/features">0.13.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-2uuxmgza2-acryldata.vercel.app/docs/features">0.12.1
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-irpoe2osc-acryldata.vercel.app/docs/features">0.11.0
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li><li>
|
||
<a class="dropdown__link" href="https://docs-website-1gv2yzn9d-acryldata.vercel.app/docs/features">0.10.5
|
||
<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
|
||
</a>
|
||
</li></ul></div></div><div class="navbar__items navbar__items--right"><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs">Docs</a><a class="navbar__item navbar__link" href="/integrations">Integrations</a><a href="https://datahub.com/slack?utm_source=docs&utm_medium=header&utm_campaign=docs_header" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.slack-logo:hover {
|
||
opacity: 0.8;
|
||
}
|
||
</style>
|
||
<img class="slack-logo" src="https://upload.wikimedia.org/wikipedia/commons/d/d5/Slack_icon_2019.svg" , alt="slack" , height="20px" style="margin: 10px 0 0 0;">
|
||
</a><a href="https://github.com/datahub-project/datahub" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">
|
||
<style>
|
||
.github-logo:hover {
|
||
opacity: 0.8;
|
||
}
|
||
</style>
|
||
<img class="github-logo" src="https://upload.wikimedia.org/wikipedia/commons/9/91/Octicons-mark-github.svg" , alt="slack" , height="20px" style="margin: 10px 0 0 0;">
|
||
</a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG menuWithAnnouncementBar_GW3s"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Getting Started</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/features">What Is DataHub?</a><button aria-label="Toggle the collapsible sidebar category 'What Is DataHub?'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/features">Features</a><button aria-label="Toggle the collapsible sidebar category 'Features'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>DataHub Cloud</div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/managed-datahub-overview">DataHub Cloud vs. DataHub OSS</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/welcome-acryl">Getting Started with DataHub Cloud</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/upgrade_core_to_cloud">Upgrading from DataHub Core to Cloud</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authentication/guides/sso/initialize-oidc">Configure Single Sign-On</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/remote-executor/about">Remote Executor</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/datahub-api/entity-events-api">DataHub API</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/slack/saas-slack-app">Slack</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/teams/saas-teams-app">Teams</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/operator-guide/setting-up-events-api-on-aws-eventbridge">Operator Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item saasOnly"><a class="menu__link" href="/docs/managed-datahub/change-proposals">Change Proposals</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/managed-datahub/chrome-extension">Cloud Chrome Extension</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item saasOnly"><a class="menu__link" href="/docs/managed-datahub/subscription-and-notification">Subscriptions & Notifications</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/managed-datahub/release-notes/v_0_3_15">DataHub Cloud Release History</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Integrations</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-ingestion">Overview</a><button aria-label="Toggle the collapsible sidebar category 'Overview'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/cli-ingestion">Quickstart Guides</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-ingestion/source_overview">Sources</a><button aria-label="Toggle the collapsible sidebar category 'Sources'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/schedule_docs/intro">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>API & SDKs</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="true" href="/docs/metadata-modeling/metadata-model">Open Source DataHub Metadata Standard</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/metadata-modeling/metadata-model">The Metadata Model</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/what/mxe">Core Metadata Events</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/generated/metamodel/entities/role">Entity Docs</a></div></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/what-is-datahub/datahub-concepts">Concepts</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/metadata-standards">Metadata Standards</a><button aria-label="Toggle the collapsible sidebar category 'Metadata Standards'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api/datahub-apis">APIs and SDKs Overview</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/api/graphql/overview">API</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/metadata-ingestion/as-a-library">Python SDK</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/metadata-integration/java/as-a-library">Java SDK</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/cli">DataHub CLI</a><button aria-label="Toggle the collapsible sidebar category 'DataHub CLI'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/act-on-metadata">DataHub Actions</a><button aria-label="Toggle the collapsible sidebar category 'DataHub Actions'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/api/tutorials/datasets">Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Admin</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/authentication">Authentication</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/authorization">Authorization</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/authorization">DataHub Authorization Overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/authorization/roles">Roles</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/authorization/policies">Policies Guide</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/authorization/groups">Authorization using Groups</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/how/delete-metadata">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Deployment</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/deployment-guides">Deployment Guides</a><button aria-label="Toggle the collapsible sidebar category 'Deployment Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/deploy/confluent-cloud">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Developers</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/architecture/architecture">Architecture</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/developers">Developing on DataHub</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/advanced/mcp-mcl">Advanced Guides</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menuHtmlItem_M9Kj menu__list-item"><div>Community</div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/category/community">Community</a><button aria-label="Toggle the collapsible sidebar category 'Community'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/releases">Release History</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Authorization</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Roles</span><meta itemprop="position" content="2"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: Next</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h1>Roles</h1><div class="availabilityCard_P5od card"><strong>Feature Availability</strong><div><span class="platform_wqXv platformAvailable_Y8lN">Self-Hosted DataHub <span role="img" aria-label="check-circle" class="anticon anticon-check-circle"><svg viewBox="64 64 896 896" focusable="false" data-icon="check-circle" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M512 64C264.6 64 64 264.6 64 512s200.6 448 448 448 448-200.6 448-448S759.4 64 512 64zm193.5 301.7l-210.6 292a31.8 31.8 0 01-51.7 0L318.5 484.9c-3.8-5.3 0-12.7 6.5-12.7h46.9c10.2 0 19.9 4.9 25.9 13.3l71.2 98.8 157.2-218c6-8.3 15.6-13.3 25.9-13.3H699c6.5 0 10.3 7.4 6.5 12.7z"></path></svg></span></span></div><div><span role="img" aria-label="cloud" class="anticon anticon-cloud managedIcon_AxXO"><svg viewBox="64 64 896 896" focusable="false" data-icon="cloud" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M811.4 418.7C765.6 297.9 648.9 212 512.2 212S258.8 297.8 213 418.6C127.3 441.1 64 519.1 64 612c0 110.5 89.5 200 199.9 200h496.2C870.5 812 960 722.5 960 612c0-92.7-63.1-170.7-148.6-193.3zm36.3 281a123.07 123.07 0 01-87.6 36.3H263.9c-33.1 0-64.2-12.9-87.6-36.3A123.3 123.3 0 01140 612c0-28 9.1-54.3 26.2-76.3a125.7 125.7 0 0166.1-43.7l37.9-9.9 13.9-36.6c8.6-22.8 20.6-44.1 35.7-63.4a245.6 245.6 0 0152.4-49.9c41.1-28.9 89.5-44.2 140-44.2s98.9 15.3 140 44.2c19.9 14 37.5 30.8 52.4 49.9 15.1 19.3 27.1 40.7 35.7 63.4l13.8 36.5 37.8 10c54.3 14.5 92.1 63.8 92.1 120 0 33.1-12.9 64.3-36.3 87.7z"></path></svg></span><span class="platform_wqXv platformAvailable_Y8lN">DataHub Cloud <span role="img" aria-label="check-circle" class="anticon anticon-check-circle"><svg viewBox="64 64 896 896" focusable="false" data-icon="check-circle" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M512 64C264.6 64 64 264.6 64 512s200.6 448 448 448 448-200.6 448-448S759.4 64 512 64zm193.5 301.7l-210.6 292a31.8 31.8 0 01-51.7 0L318.5 484.9c-3.8-5.3 0-12.7 6.5-12.7h46.9c10.2 0 19.9 4.9 25.9 13.3l71.2 98.8 157.2-218c6-8.3 15.6-13.3 25.9-13.3H699c6.5 0 10.3 7.4 6.5 12.7z"></path></svg></span></span></div></div><p>DataHub provides the ability to use <strong>Roles</strong> to manage permissions.</p><div class="theme-admonition theme-admonition-tip alert alert--success admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span><mdxadmonitiontitle><strong>Roles</strong> are the recommended way to manage permissions on DataHub. This should suffice for most use cases, but advanced users can use <strong>Policies</strong> if needed.</mdxadmonitiontitle></div><div class="admonitionContent_S0QG"><h2 class="anchor anchorWithStickyNavbar_LWe7" id="roles-setup-prerequisites-and-permissions">Roles Setup, Prerequisites, and Permissions<a href="#roles-setup-prerequisites-and-permissions" class="hash-link" aria-label="Direct link to Roles Setup, Prerequisites, and Permissions" title="Direct link to Roles Setup, Prerequisites, and Permissions"></a></h2><p>The out-of-the-box Roles represent the most common types of DataHub users. Currently, the supported Roles are <strong>Admin</strong>, <strong>Editor</strong> and <strong>Reader</strong>.</p><table><thead><tr><th>Role Name</th><th>Description</th></tr></thead><tbody><tr><td>Admin</td><td>Can do everything on the platform.</td></tr><tr><td>Editor</td><td>Can read and edit all metadata. Cannot take administrative actions.</td></tr><tr><td>Reader</td><td>Can read all metadata. Cannot edit anything by default, or take administrative actions.</td></tr></tbody></table></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="using-roles">Using Roles<a href="#using-roles" class="hash-link" aria-label="Direct link to Using Roles" title="Direct link to Using Roles"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="viewing-roles">Viewing Roles<a href="#viewing-roles" class="hash-link" aria-label="Direct link to Viewing Roles" title="Direct link to Viewing Roles"></a></h3><p>You can view the list of existing Roles under <strong>Settings > Permissions > Roles</strong>. You can click into a Role to see details about
|
||
it, like which users have that Role, and which Policies correspond to that Role.</p><p align="center"><img loading="lazy" width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/roles/view-roles-list.png" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="assigning-roles">Assigning Roles<a href="#assigning-roles" class="hash-link" aria-label="Direct link to Assigning Roles" title="Direct link to Assigning Roles"></a></h3><p>Roles can be assigned in two different ways.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="assigning-a-new-role-to-a-single-user">Assigning a New Role to a Single User<a href="#assigning-a-new-role-to-a-single-user" class="hash-link" aria-label="Direct link to Assigning a New Role to a Single User" title="Direct link to Assigning a New Role to a Single User"></a></h4><p>If you go to <strong>Settings > Users & Groups > Users</strong>, you will be able to view your full list of users, as well as which Role they are currently
|
||
assigned to, including if they don't have a Role.</p><p align="center"><img loading="lazy" width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/roles/user-list-roles.png" class="img_ev3q"></p><p>You can simply assign a new Role to a user by clicking on the drop-down that appears on their row and selecting the desired Role.</p><p align="center"><img loading="lazy" width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/roles/user-list-select-role.png" class="img_ev3q"></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="batch-assigning-a-role">Batch Assigning a Role<a href="#batch-assigning-a-role" class="hash-link" aria-label="Direct link to Batch Assigning a Role" title="Direct link to Batch Assigning a Role"></a></h4><p>When viewing the full list of roles at <strong>Settings > Permissions > Roles</strong>, you will notice that each role has an <code>Add Users</code> button next to it. Clicking this button will
|
||
lead you to a search box where you can search through your users, and select which users you would like to assign this role to.</p><p align="center"><img loading="lazy" width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/roles/batch-assign-role.png" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-roles-interact-with-policies">How do Roles interact with Policies?<a href="#how-do-roles-interact-with-policies" class="hash-link" aria-label="Direct link to How do Roles interact with Policies?" title="Direct link to How do Roles interact with Policies?"></a></h3><p>Roles actually use Policies under-the-hood, and come prepackaged with corresponding policies to control what a Role can do, which you can view in the
|
||
Policies tab. Note that these Role-specific policies <strong>cannot</strong> be changed. You can find the full list of policies corresponding to each Role at the bottom of this
|
||
<a href="https://github.com/datahub-project/datahub/blob/master/metadata-service/war/src/main/resources/boot/policies.json" target="_blank" rel="noopener noreferrer">file</a>.</p><p>If you would like to have finer control over what a user on your DataHub instance can do, the Roles system interfaces cleanly
|
||
with the Policies system. For example, if you would like to give a user a <strong>Reader</strong> role, but also allow them to edit metadata
|
||
for certain domains, you can add a policy that will allow them to do. Note that adding a policy like this will only add to what a user can do
|
||
in DataHub.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="role-privileges">Role Privileges<a href="#role-privileges" class="hash-link" aria-label="Direct link to Role Privileges" title="Direct link to Role Privileges"></a></h3><h4 class="anchor anchorWithStickyNavbar_LWe7" id="self-hosted-datahub-and-datahub-cloud">Self-Hosted DataHub and DataHub Cloud<a href="#self-hosted-datahub-and-datahub-cloud" class="hash-link" aria-label="Direct link to Self-Hosted DataHub and DataHub Cloud" title="Direct link to Self-Hosted DataHub and DataHub Cloud"></a></h4><p>These privileges are common to both Self-Hosted DataHub and DataHub Cloud.</p><h5 class="anchor anchorWithStickyNavbar_LWe7" id="platform-privileges">Platform Privileges<a href="#platform-privileges" class="hash-link" aria-label="Direct link to Platform Privileges" title="Direct link to Platform Privileges"></a></h5><table><thead><tr><th>Privilege</th><th>Admin</th><th>Editor</th><th>Reader</th><th>Description</th></tr></thead><tbody><tr><td>Generate Personal Access Tokens</td><td>✔️</td><td>✔️</td><td>❌</td><td>Generate personal access tokens for use with DataHub APIs.</td></tr><tr><td>Manage Domains</td><td>✔️</td><td>✔️</td><td>❌</td><td>Create and remove Asset Domains.</td></tr><tr><td>Manage Home Page Posts</td><td>✔️</td><td>✔️</td><td>❌</td><td>Create and delete home page posts</td></tr><tr><td>Manage Glossaries</td><td>✔️</td><td>✔️</td><td>❌</td><td>Create, edit, and remove Glossary Entities</td></tr><tr><td>Manage Tags</td><td>✔️</td><td>✔️</td><td>❌</td><td>Create and remove Tags.</td></tr><tr><td>Manage Business Attribute</td><td>✔️</td><td>✔️</td><td>❌</td><td>Create, update, delete Business Attribute</td></tr><tr><td>Manage Documentation Forms</td><td>✔️</td><td>✔️</td><td>❌</td><td>Manage forms assigned to assets to assist in documentation efforts.</td></tr><tr><td>Manage Policies</td><td>✔️</td><td>❌</td><td>❌</td><td>Create and remove access control policies. Be careful - Actors with this privilege are effectively super users.</td></tr><tr><td>Manage Metadata Ingestion</td><td>✔️</td><td>❌</td><td>❌</td><td>Create, remove, and update Metadata Ingestion sources.</td></tr><tr><td>Manage Secrets</td><td>✔️</td><td>❌</td><td>❌</td><td>Create & remove Secrets stored inside DataHub.</td></tr><tr><td>Manage Users & Groups</td><td>✔️</td><td>❌</td><td>❌</td><td>Create, remove, and update users and groups on DataHub.</td></tr><tr><td>View Analytics</td><td>✔️</td><td>❌</td><td>❌</td><td>View the DataHub analytics dashboard.</td></tr><tr><td>Manage All Access Tokens</td><td>✔️</td><td>❌</td><td>❌</td><td>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.</td></tr><tr><td>Manage User Credentials</td><td>✔️</td><td>❌</td><td>❌</td><td>Manage credentials for native DataHub users, including inviting new users and resetting passwords</td></tr><tr><td>Manage Public Views</td><td>✔️</td><td>❌</td><td>❌</td><td>Create, update, and delete any Public (shared) Views.</td></tr><tr><td>Manage Ownership Types</td><td>✔️</td><td>❌</td><td>❌</td><td>Create, update and delete Ownership Types.</td></tr><tr><td>Create Business Attribute</td><td>✔️</td><td>❌</td><td>❌</td><td>Create new Business Attribute.</td></tr><tr><td>Manage Connections</td><td>✔️</td><td>❌</td><td>❌</td><td>Manage connections to external DataHub platforms.</td></tr><tr><td>Restore Indices API</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to use the Restore Indices API.</td></tr><tr><td>Get Timeseries index sizes API</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to use the get Timeseries indices size API.</td></tr><tr><td>Truncate timeseries aspect index size API</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to use the API to truncate a timeseries index.</td></tr><tr><td>Get ES task status API</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to use the get task status API for an ElasticSearch task.</td></tr><tr><td>Enable/Disable Writeability API</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to enable or disable GMS writeability for data migrations.</td></tr><tr><td>Apply Retention API</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to apply retention using the API.</td></tr><tr><td>Analytics API access</td><td>✔️</td><td>❌</td><td>❌</td><td>API read access to raw analytics data.</td></tr></tbody></table><h5 class="anchor anchorWithStickyNavbar_LWe7" id="metadata-privileges">Metadata Privileges<a href="#metadata-privileges" class="hash-link" aria-label="Direct link to Metadata Privileges" title="Direct link to Metadata Privileges"></a></h5><table><thead><tr><th>Privilege</th><th>Admin</th><th>Editor</th><th>Reader</th><th>Description</th></tr></thead><tbody><tr><td>View Entity Page</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to view the entity page.</td></tr><tr><td>View Dataset Usage</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to access dataset usage information (includes usage statistics and queries).</td></tr><tr><td>View Dataset Profile</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to access dataset profile (snapshot statistics)</td></tr><tr><td>Edit Tags</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to add and remove tags to an asset.</td></tr><tr><td>Edit Glossary Terms</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to add and remove glossary terms to an asset.</td></tr><tr><td>Edit Description</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to edit the description (documentation) of an entity.</td></tr><tr><td>Edit Links</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to edit links associated with an entity.</td></tr><tr><td>Edit Status</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to edit the status of an entity (soft deleted or not).</td></tr><tr><td>Edit Domain</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to edit the Domain of an entity.</td></tr><tr><td>Edit Data Product</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to edit the Data Product of an entity.</td></tr><tr><td>Edit Deprecation</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to edit the Deprecation status of an entity.</td></tr><tr><td>Edit Assertions</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to add and remove assertions from an entity.</td></tr><tr><td>Edit Incidents</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to create and remove incidents for an entity.</td></tr><tr><td>Edit Entity</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to edit any information about an entity. Super user privileges for the entity.</td></tr><tr><td>Edit Dataset Column Tags</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to edit the column (field) tags associated with a dataset schema.</td></tr><tr><td>Edit Dataset Column Glossary Terms</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to edit the column (field) glossary terms associated with a dataset schema.</td></tr><tr><td>Edit Dataset Column Descriptions</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to edit the column (field) descriptions associated with a dataset schema.</td></tr><tr><td>Edit Tag Color</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to change the color of a Tag.</td></tr><tr><td>Edit Lineage</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to add and remove lineage edges for this entity.</td></tr><tr><td>Edit Dataset Queries</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to edit the Queries for a Dataset.</td></tr><tr><td>Execute Entity</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to execute ingestion for an Entity.</td></tr><tr><td>Manage Data Products</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to create, edit, and delete Data Products within a Domain</td></tr><tr><td>Edit Properties</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to edit the properties for an entity.</td></tr><tr><td>Edit Owners</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to add and remove owners of an entity.</td></tr><tr><td>Edit Group Members</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to add and remove members to a group.</td></tr><tr><td>Edit User Profile</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to change the user's profile including display name, bio, title, profile image, etc.</td></tr><tr><td>Edit Contact Information</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to change the contact information such as email & chat handles.</td></tr><tr><td>Delete</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to delete this entity.</td></tr><tr><td>Search API</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to access search APIs.</td></tr><tr><td>Get Aspect/Entity Count APIs</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to use the GET Aspect/Entity Count APIs.</td></tr><tr><td>Get Timeseries Aspect API</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to use the GET Timeseries Aspect API.</td></tr><tr><td>Get Entity + Relationships API</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to use the GET Entity and Relationships API.</td></tr><tr><td>Get Timeline API</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to use the GET Timeline API.</td></tr><tr><td>Explain ElasticSearch Query API</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to use the Operations API explain endpoint.</td></tr><tr><td>Produce Platform Event API</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to produce Platform Events using the API.</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="datahub-cloud">DataHub Cloud<a href="#datahub-cloud" class="hash-link" aria-label="Direct link to DataHub Cloud" title="Direct link to DataHub Cloud"></a></h4><p>These privileges are only relevant to DataHub Cloud.</p><h5 class="anchor anchorWithStickyNavbar_LWe7" id="platform-privileges-1">Platform Privileges<a href="#platform-privileges-1" class="hash-link" aria-label="Direct link to Platform Privileges" title="Direct link to Platform Privileges"></a></h5><table><thead><tr><th>Privilege</th><th>Admin</th><th>Editor</th><th>Reader</th><th>Description</th></tr></thead><tbody><tr><td>Manage Tests</td><td>✔️</td><td>✔️</td><td>❌</td><td>Create and remove Asset Tests.</td></tr><tr><td>View Metadata Proposals</td><td>✔️</td><td>✔️</td><td>❌</td><td>View the requests tab for viewing metadata proposals.</td></tr><tr><td>Create metadata constraints<sup id="fnref-1"><a href="#fn-1" class="footnote-ref">1</a></sup></td><td>✔️</td><td>✔️</td><td>❌</td><td>Create metadata constraints.</td></tr><tr><td>Manage Platform Settings</td><td>✔️</td><td>❌</td><td>❌</td><td>View and change platform-level settings, like integrations & notifications.</td></tr><tr><td>Manage Monitors</td><td>✔️</td><td>❌</td><td>❌</td><td>Create, update, and delete any data asset monitors, including Custom SQL monitors. Grant with care.</td></tr></tbody></table><h5 class="anchor anchorWithStickyNavbar_LWe7" id="metadata-privileges-1">Metadata Privileges<a href="#metadata-privileges-1" class="hash-link" aria-label="Direct link to Metadata Privileges" title="Direct link to Metadata Privileges"></a></h5><table><thead><tr><th>Privilege</th><th>Admin</th><th>Editor</th><th>Reader</th><th>Description</th></tr></thead><tbody><tr><td>View Entity</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to view the entity in search results.</td></tr><tr><td>Propose Tags</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to propose adding a tag to an asset.</td></tr><tr><td>Propose Glossary Terms</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to propose adding a glossary term to an asset.</td></tr><tr><td>Propose Documentation</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to propose updates to an asset's documentation.</td></tr><tr><td>Propose Dataset Column Glossary Terms</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to propose column (field) glossary terms associated with a dataset schema.</td></tr><tr><td>Propose Dataset Column Tags</td><td>✔️</td><td>✔️</td><td>✔️</td><td>The ability to propose new column (field) tags associated with a dataset schema.</td></tr><tr><td>Manage Tag Proposals</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to manage a proposal to add a tag to an asset.</td></tr><tr><td>Manage Glossary Term Proposals</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to manage a proposal to add a glossary term to an asset.</td></tr><tr><td>Manage Dataset Column Glossary Terms</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to manage column (field) glossary term proposals associated with a dataset schema.</td></tr><tr><td>Manage Dataset Column Tag Proposals</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to manage column (field) tag proposals associated with a dataset schema.</td></tr><tr><td>Manage Documentation Proposals</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to manage a proposal update an asset's documentation</td></tr><tr><td>Manage Group Notification Settings</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to manage notification settings for a group.</td></tr><tr><td>Manage Group Subscriptions</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to manage subscriptions for a group.</td></tr><tr><td>Manage User Subscriptions</td><td>✔️</td><td>❌</td><td>❌</td><td>The ability to manage subscriptions for another user.</td></tr><tr><td>Manage Data Contract Proposals</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to manage a proposal for a Data Contract</td></tr><tr><td>Share Entity</td><td>✔️</td><td>✔️</td><td>❌</td><td>The ability to share an entity with another DataHub Cloud instance.</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="additional-resources">Additional Resources<a href="#additional-resources" class="hash-link" aria-label="Direct link to Additional Resources" title="Direct link to Additional Resources"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="graphql">GraphQL<a href="#graphql" class="hash-link" aria-label="Direct link to GraphQL" title="Direct link to GraphQL"></a></h3><ul><li><a href="/docs/graphql/mutations#acceptrole">acceptRole</a></li><li><a href="/docs/graphql/mutations#batchassignrole">batchAssignRole</a></li><li><a href="/docs/graphql/queries#listroles">listRoles</a></li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="faq-and-troubleshooting">FAQ and Troubleshooting<a href="#faq-and-troubleshooting" class="hash-link" aria-label="Direct link to FAQ and Troubleshooting" title="Direct link to FAQ and Troubleshooting"></a></h2><h2 class="anchor anchorWithStickyNavbar_LWe7" id="what-updates-are-planned-for-roles">What updates are planned for Roles?<a href="#what-updates-are-planned-for-roles" class="hash-link" aria-label="Direct link to What updates are planned for Roles?" title="Direct link to What updates are planned for Roles?"></a></h2><p>In the future, the DataHub team is looking into adding the following features to Roles.</p><ul><li>Defining a role mapping from OIDC identity providers to DataHub that will grant users a DataHub role based on their IdP role</li><li>Allowing Admins to set a default role on DataHub so all users are assigned a role</li><li>Building custom roles</li></ul><div class="footnotes"><hr><ol><li id="fn-1">Deprecated feature<a href="#fnref-1" class="footnote-backref">↩</a></li></ol></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="slackUtm_uoBr"><div class="slackUtm_uoBr"><hr>Need more help? Join the conversation in <a href="https://datahub.com/slack?utm_source=docs&utm_medium=footer&utm_campaign=docs_footer&utm_content=docs/authorization/roles">Slack!</a></div></div><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/datahub-project/datahub/blob/master/docs/authorization/roles.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_VsjB"></div></div></footer><div class="feedbackWrapper_mUHF"><div class="feedbackWidget_PX4d"><div class="feedbackButtons_wn3V"><strong>Is this page helpful?</strong><div><button class="feedbackButton_UgQs"><span role="img" aria-label="like" class="anticon anticon-like"><svg viewBox="64 64 896 896" focusable="false" data-icon="like" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 533.7c16.8-22.2 26.1-49.4 26.1-77.7 0-44.9-25.1-87.4-65.5-111.1a67.67 67.67 0 00-34.3-9.3H572.4l6-122.9c1.4-29.7-9.1-57.9-29.5-79.4A106.62 106.62 0 00471 99.9c-52 0-98 35-111.8 85.1l-85.9 311H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h601.3c9.2 0 18.2-1.8 26.5-5.4 47.6-20.3 78.3-66.8 78.3-118.4 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7 0-12.6-1.8-25-5.4-37 16.8-22.2 26.1-49.4 26.1-77.7-.2-12.6-2-25.1-5.6-37.1zM184 852V568h81v284h-81zm636.4-353l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 16.5-7.2 32.2-19.6 43l-21.9 19 13.9 25.4a56.2 56.2 0 016.9 27.3c0 22.4-13.2 42.6-33.6 51.8H329V564.8l99.5-360.5a44.1 44.1 0 0142.2-32.3c7.6 0 15.1 2.2 21.1 6.7 9.9 7.4 15.2 18.6 14.6 30.5l-9.6 198.4h314.4C829 418.5 840 436.9 840 456c0 16.5-7.2 32.1-19.6 43z"></path></svg></span></button><button class="feedbackButton_UgQs"><span role="img" aria-label="dislike" class="anticon anticon-dislike"><svg viewBox="64 64 896 896" focusable="false" data-icon="dislike" width="1em" height="1em" fill="currentColor" aria-hidden="true"><path d="M885.9 490.3c3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-28.3-9.3-55.5-26.1-77.7 3.6-12 5.4-24.4 5.4-37 0-51.6-30.7-98.1-78.3-118.4a66.1 66.1 0 00-26.5-5.4H144c-17.7 0-32 14.3-32 32v364c0 17.7 14.3 32 32 32h129.3l85.8 310.8C372.9 889 418.9 924 470.9 924c29.7 0 57.4-11.8 77.9-33.4 20.5-21.5 31-49.7 29.5-79.4l-6-122.9h239.9c12.1 0 23.9-3.2 34.3-9.3 40.4-23.5 65.5-66.1 65.5-111 0-28.3-9.3-55.5-26.1-77.7zM184 456V172h81v284h-81zm627.2 160.4H496.8l9.6 198.4c.6 11.9-4.7 23.1-14.6 30.5-6.1 4.5-13.6 6.8-21.1 6.7a44.28 44.28 0 01-42.2-32.3L329 459.2V172h415.4a56.85 56.85 0 0133.6 51.8c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-13.9 25.4 21.9 19a56.76 56.76 0 0119.6 43c0 9.7-2.3 18.9-6.9 27.3l-14 25.5 21.9 19a56.76 56.76 0 0119.6 43c0 19.1-11 37.5-28.8 48.4z"></path></svg></span></button></div></div></div></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/authorization"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">DataHub Authorization Overview</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/authorization/policies"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Policies Guide</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#using-roles" class="table-of-contents__link toc-highlight">Using Roles</a><ul><li><a href="#viewing-roles" class="table-of-contents__link toc-highlight">Viewing Roles</a></li><li><a href="#assigning-roles" class="table-of-contents__link toc-highlight">Assigning Roles</a></li><li><a href="#how-do-roles-interact-with-policies" class="table-of-contents__link toc-highlight">How do Roles interact with Policies?</a></li><li><a href="#role-privileges" class="table-of-contents__link toc-highlight">Role Privileges</a></li></ul></li><li><a href="#additional-resources" class="table-of-contents__link toc-highlight">Additional Resources</a><ul><li><a href="#graphql" class="table-of-contents__link toc-highlight">GraphQL</a></li></ul></li><li><a href="#faq-and-troubleshooting" class="table-of-contents__link toc-highlight">FAQ and Troubleshooting</a></li><li><a href="#what-updates-are-planned-for-roles" class="table-of-contents__link toc-highlight">What updates are planned for Roles?</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/quickstart">Quickstart</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://datahub.com/slack" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" target="_blank" rel="noopener noreferrer" class="footer__link-item">YouTube<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://medium.com/datahub-project" target="_blank" rel="noopener noreferrer" class="footer__link-item">Blog<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/townhalls">Town Halls</a></li><li class="footer__item"><a href="https://datahub.com/resources/?2004611554=dh-stories" target="_blank" rel="noopener noreferrer" class="footer__link-item">Customer Stories<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://demo.datahub.com/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Demo</a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/roadmap" target="_blank" rel="noopener noreferrer" class="footer__link-item">Roadmap<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/docs/contributing">Contributing</a></li><li class="footer__item"><a href="https://github.com/datahub-project/datahub" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://feature-requests.datahubproject.io/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Feature Requests<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2015-2025 DataHub Project Authors.</div></div></div></footer></div>
|
||
<script src="/assets/js/runtime~main.07cf073e.js"></script>
|
||
<script src="/assets/js/main.60e11739.js"></script>
|
||
</body>
|
||
</html> |