🔒 Admin only. Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.Creates a role and returns it with the id to assign it by. Role names are unique, so recreating one that already exists answers 409.To scope the role to specific deployments, send a Deployment policy whose resources are the deployment ids as strings. A role usually also needs a Global policy naming the holder’s license tier — AIBIView, AIBIExplore or AIBIDevelop — which is what the console calls the role’s Base Role. List SignIn in that Global policy too: a role sent without it does not let its holders sign in to the console. Pick a tier that covers the deployment actions you grant: the console forces Developer (AIBIDevelop) for every deployment action except DeploymentRead, DeploymentAgentRead, DownloadData and ChatHistoryRead, so a lower tier here produces a role its role builder would not have let you save:
The tier is not required and is not derived from the deployment actions: a role sent without one is accepted and simply confers no tier, so a user holding only that role gets the deployment grants and still cannot use the product. That is deliberate — a user holds the union of their roles, so a role that only adds a deployment scope beside another role carrying the tier is valid — but it means nothing warns you. Omit the Global policy only when some other role supplies the tier. Note the console does require one on every role it writes, so a role created here without a tier shows an unset Base Role when opened in the role builder.Use ["All"] as resources to cover every deployment, and "All" as the single action for full access to the deployments in scope. A policy is rejected when it grants no action, when it names no resource, or when a Deployment resource is not a deployment id — pass the numeric id returned by POST /build/api/v1/deployments, not a slug or a name. Ids are checked for shape, not existence, so an id whose deployment was since deleted is kept and simply grants nothing.An API key scoped to specific deployments answers 403 here.
Unique role name. Cannot be one of the built-in role names, which are rejected with 400: Admin, Developer, AIBIDeveloper, D3User, AIBIUser, AIBIViewer, Guest, EmbedUser. (The console additionally refuses None and All in its own role builder; those are accepted here.)
Required string length: 1 - 255
policies
object[]
required
What the role grants. Scope a policy to specific deployments by setting resourceType to Deployment and listing the deployment ids — as returned by POST /build/api/v1/deployments — in resources, or ["All"] for every deployment. An empty policies list is accepted and creates a role that grants nothing yet; an individual policy with no actions, or none naming a resource, is rejected.
Maximum array length: 200
Show child attributes
description
string | null
Maximum string length: 255
Response
id
integer
required
name
string
required
policies
object[]
required
Show child attributes
description
string | null
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cube Documentation","colors":{"primary":"#5339CF","light":"#A5A3FF","dark":"#716EEE"},"logo":{"light":"https://mintcdn.com/cubed3/wCTntgEXVYYYnx4l/logo/light.svg?fit=max\u0026auto=format\u0026n=wCTntgEXVYYYnx4l\u0026q=85\u0026s=8bbf45ba64eac6116629064fac55aad7","dark":"https://mintcdn.com/cubed3/wCTntgEXVYYYnx4l/logo/dark.svg?fit=max\u0026auto=format\u0026n=wCTntgEXVYYYnx4l\u0026q=85\u0026s=d8fa230950c8c63b3c2f88d2768694d0"},"favicon":"https://mintcdn.com/cubed3/wCTntgEXVYYYnx4l/favicon.svg?fit=max\u0026auto=format\u0026n=wCTntgEXVYYYnx4l\u0026q=85\u0026s=3b0cb7aa770d2abd546ef19463fbba8c","navbar":{"links":[{"href":"https://cube.dev/demos","label":"Demos"},{"href":"https://cube.dev/changelog","label":"Changelog"},{"href":"https://slack.cube.dev","label":"Community"}],"primary":{"type":"button","label":"Get Started","href":"https://cubecloud.dev/auth/signup"}},"footer":{"socials":{"x":"https://x.com/the_cube_dev","github":"https://github.com/cube-js/cube","linkedin":"https://www.linkedin.com/company/cube-dev"},"links":[{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://cube.dev/legal/privacy-policy"},{"label":"Cookie Preferences","href":"#cookie-preferences"}]}]},"seo":{"metatags":{"og:type":"website","og:site_name":"Cube Documentation"},"indexing":"navigable"},"icons":{"library":"tabler"},"styling":{"codeblocks":"dark","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cubed3","hasAudioNarration":false,"actualSubdomain":"cubed3","customDomains":["docs.cube.dev"],"gitSource":{"type":"github","owner":"cube-js","repo":"cube","deployBranch":"master","contentDirectory":"docs-mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af92ce85a8e334304f87df0","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API","count":236},{"language":"default","tag":"Platform Endpoints","count":229},{"language":"default","tag":"Documentation","count":102},{"language":"default","tag":"Admin","count":95},{"language":"default","tag":"Data Modeling","count":65},{"language":"default","tag":"Recipes","count":47},{"language":"default","tag":"Topics","count":47},{"language":"default","tag":"Reference","count":44},{"language":"default","tag":"Connect to data","count":31},{"language":"default","tag":"Explore \u0026 Analyze","count":30}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#content-area table,.mdx-content table{width:100%!important}.cube-consent{position:fixed;right:16px;bottom:16px;z-index:2147483000;box-sizing:border-box;display:flex;flex-direction:column;gap:8px;width:min(440px, calc(100vw - 32px));padding:16px;background:#fff;color:#111827;border:1px solid #e5e7eb;border-radius:8px;box-shadow:0 8px 24px rgb(0 0 0 / 12%);font-size:14px;line-height:1.5}html.dark .cube-consent{background:#111318;color:#f3f4f6;border-color:#2b2f38}.cube-consent__title{margin:0;padding-right:24px;font-size:16px;font-weight:600}.cube-consent__text,.cube-consent__status{margin:0;color:#4b5563}html.dark .cube-consent__text,html.dark .cube-consent__status{color:#b6bcc8}.cube-consent__link{color:inherit;text-decoration:underline}.cube-consent__actions{display:flex;gap:8px}.cube-consent__button{flex:1;padding:8px 16px;border:1px solid #111827;border-radius:6px;background:#111827;color:#fff;font:inherit;font-weight:500;cursor:pointer}html.dark .cube-consent__button{border-color:#f3f4f6;background:#f3f4f6;color:#111318}.cube-consent__button:hover{opacity:0.88}.cube-consent__button:focus-visible,.cube-consent__close:focus-visible,.cube-consent__link:focus-visible{outline:2px solid #111827;outline-offset:2px}html.dark .cube-consent :focus-visible{outline-color:#f3f4f6}.cube-consent__close{position:absolute;top:8px;right:8px;width:24px;height:24px;padding:0;border:0;background:transparent;color:inherit;font-size:20px;line-height:1;cursor:pointer}"}],"page":{"pagePath":"api-reference/roles/create-a-custom-role","slug":"/api-reference/roles/create-a-custom-role","pageMetadata":{"title":"Create a custom role","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/roles","href":"/api-reference/roles/create-a-custom-role","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`🔒 Admin only.`}),` Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.`]}),`\n`,_jsxs(_components.p,{children:[`Creates a role and returns it with the `,_jsx(_components.code,{children:`id`}),` to assign it by. Role names are unique, so recreating one that already exists answers `,_jsx(_components.code,{children:`409`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`To scope the role to specific deployments, send a `,_jsx(_components.code,{children:`Deployment`}),` policy whose `,_jsx(_components.code,{children:`resources`}),` are the deployment ids as strings. A role usually also needs a `,_jsx(_components.code,{children:`Global`}),` policy naming the holder’s license tier — `,_jsx(_components.code,{children:`AIBIView`}),`, `,_jsx(_components.code,{children:`AIBIExplore`}),` or `,_jsx(_components.code,{children:`AIBIDevelop`}),` — which is what the console calls the role’s Base Role. List `,_jsx(_components.code,{children:`SignIn`}),` in that `,_jsx(_components.code,{children:`Global`}),` policy too: a role sent without it does not let its holders sign in to the console. Pick a tier that covers the deployment actions you grant: the console forces Developer (`,_jsx(_components.code,{children:`AIBIDevelop`}),`) for every deployment action except `,_jsx(_components.code,{children:`DeploymentRead`}),`, `,_jsx(_components.code,{children:`DeploymentAgentRead`}),`, `,_jsx(_components.code,{children:`DownloadData`}),` and `,_jsx(_components.code,{children:`ChatHistoryRead`}),`, so a lower tier here produces a role its role builder would not have let you save:`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`15`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`15`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"team-analytics\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"policies\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"resourceType\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"Global\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"actions\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"AIBIDevelop\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"SignIn\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"resources\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"All\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"resourceType\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"Deployment\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"actions\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"DeploymentRead\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"SchemaRead\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"SqlRunnerRead\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"resources\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"1734\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The tier is `,_jsx(_components.strong,{children:`not`}),` required and is `,_jsx(_components.strong,{children:`not`}),` derived from the deployment actions: a role sent without one is accepted and simply confers no tier, so a user holding only that role gets the deployment grants and still cannot use the product. That is deliberate — a user holds the union of their roles, so a role that only adds a deployment scope beside another role carrying the tier is valid — but it means nothing warns you. Omit the `,_jsx(_components.code,{children:`Global`}),` policy only when some other role supplies the tier. Note the console does require one on every role it writes, so a role created here without a tier shows an unset Base Role when opened in the role builder.`]}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`[\"All\"]`}),` as `,_jsx(_components.code,{children:`resources`}),` to cover every deployment, and `,_jsx(_components.code,{children:`\"All\"`}),` as the single action for full access to the deployments in scope. A policy is rejected when it grants no action, when it names no resource, or when a `,_jsx(_components.code,{children:`Deployment`}),` resource is not a deployment id — pass the numeric id returned by POST /build/api/v1/deployments, not a slug or a name. Ids are checked for shape, not existence, so an id whose deployment was since deleted is kept and simply grants nothing.`]}),`\n`,_jsxs(_components.p,{children:[`An API key scoped to specific deployments answers `,_jsx(_components.code,{children:`403`}),` here.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Create a custom role","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/roles","href":"/api-reference/roles/create-a-custom-role","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/cubed3/73c42f6b43b9b3b0/scripts/extract-chat.js","/_mintlify/custom/cubed3/08d502537a7bd0d7/scripts/extract-core-data.js","/_mintlify/custom/cubed3/476a9fa93e98d93b/consent.js"],"openApiReferenceData":{"operation":{"operationId":"createRole","requestBody":"bc0c8520-d72d-435a-8948-1f4791e2f724","responses":{"200":"5ec20c58-41a5-471e-a854-0bdb00861b68","400":"a2cd6e94-b47f-40d7-aa6a-1d036c2930cc","409":"c272e4a3-491d-48f9-a775-e6f55a936075"},"summary":"Create a custom role","tags":["Roles"],"x-mint":{"content":"**🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.\n\nCreates a role and returns it with the `id` to assign it by. Role names are unique, so recreating one that already exists answers `409`.\n\nTo scope the role to specific deployments, send a `Deployment` policy whose `resources` are the deployment ids as strings. A role usually also needs a `Global` policy naming the holder's license tier — `AIBIView`, `AIBIExplore` or `AIBIDevelop` — which is what the console calls the role's Base Role. List `SignIn` in that `Global` policy too: a role sent without it does not let its holders sign in to the console. Pick a tier that covers the deployment actions you grant: the console forces Developer (`AIBIDevelop`) for every deployment action except `DeploymentRead`, `DeploymentAgentRead`, `DownloadData` and `ChatHistoryRead`, so a lower tier here produces a role its role builder would not have let you save:\n\n```json\n{\n \"name\": \"team-analytics\",\n \"policies\": [\n {\n \"resourceType\": \"Global\",\n \"actions\": [\"AIBIDevelop\", \"SignIn\"],\n \"resources\": [\"All\"]\n },\n {\n \"resourceType\": \"Deployment\",\n \"actions\": [\"DeploymentRead\", \"SchemaRead\", \"SqlRunnerRead\"],\n \"resources\": [\"1734\"]\n }\n ]\n}\n```\n\nThe tier is **not** required and is **not** derived from the deployment actions: a role sent without one is accepted and simply confers no tier, so a user holding only that role gets the deployment grants and still cannot use the product. That is deliberate — a user holds the union of their roles, so a role that only adds a deployment scope beside another role carrying the tier is valid — but it means nothing warns you. Omit the `Global` policy only when some other role supplies the tier. Note the console does require one on every role it writes, so a role created here without a tier shows an unset Base Role when opened in the role builder.\n\nUse `[\"All\"]` as `resources` to cover every deployment, and `\"All\"` as the single action for full access to the deployments in scope. A policy is rejected when it grants no action, when it names no resource, or when a `Deployment` resource is not a deployment id — pass the numeric id returned by POST /build/api/v1/deployments, not a slug or a name. Ids are checked for shape, not existence, so an id whose deployment was since deleted is kept and simply grants nothing.\n\nAn API key scoped to specific deployments answers `403` here."},"method":"post","type":"path","servers":["bd7f78b9-135c-4ce0-b9db-2b2e2f5de545"],"security":["5486a535-83a1-4621-9d33-d81817fae67c"],"path":"/api/v1/roles","baseUrlOptions":["https://{tenant}.cubecloud.dev"],"title":"Create a custom role","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"Unique role name. Cannot be one of the built-in role names, which are rejected with `400`: `Admin`, `Developer`, `AIBIDeveloper`, `D3User`, `AIBIUser`, `AIBIViewer`, `Guest`, `EmbedUser`. (The console additionally refuses `None` and `All` in its own role builder; those are accepted here.)","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"policies":{"description":"What the role grants. Scope a policy to specific deployments by setting `resourceType` to `Deployment` and listing the deployment ids — as returned by POST /build/api/v1/deployments — in `resources`, or `[\"All\"]` for every deployment. An empty `policies` list is accepted and creates a role that grants nothing yet; an individual policy with no actions, or none naming a resource, is rejected.","items":{"properties":{"actions":{"items":{"enum":["All","DeploymentsManage","SignIn","DeploymentCreate","DeploymentRead","DeploymentUpdate","DeploymentDelete","SecretsManage","DownloadData","PlaygroundRead","SchemaRead","SchemaUpdate","SchemaUpdateDevBranches","APMRead","ChatHistoryRead","PreAggregationRead","PreAggregationBuild","AlertsCreate","AlertsRead","AlertsUpdate","AlertsDelete","AuditLogManage","BillingRead","SqlRunnerRead","DataAssetsRead","DataAssetsManage","CubeNetworkConnect","ReportRead","ReportEdit","ReportManage","WorkbookManage","WorkbookRead","WorkbookEdit","ChatThreadRead","AgentManage","AgentRead","AgentSpaceManage","AgentAdmin","DeploymentAgentRead","ScheduledTasksCreate","ScheduledTaskRead","ScheduledTasksRead","ScheduledTasksManage","OAuthIntegrationsManage","OAuthIntegrationsIssueTokens","McpToolsManage","AIBIDevelop","AIBIExplore","AIBIView","ChartPalettesManage","DashboardThemesManage","AIBIDeveloper","AIBIUser","AIBIViewer","EmbedDeploymentRead","EmbedDashboardRead","FolderRead","FolderEdit","FolderManage"],"type":"string","uniqueKey":"policies.items.[INDEX].actions.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"policies.items.[INDEX].actions","typeLabel":"enum\u003cstring>[]"},"resourceType":{"enum":["Global","Deployment","Report","ReportFolder","Agent","AgentSpace","Workbook","Dashboard","Folder","ChatThread","ScheduledTask"],"type":"string","isRequired":true,"uniqueKey":"policies.items.[INDEX].resourceType","typeLabel":"enum\u003cstring>"},"resources":{"items":{"type":"string","uniqueKey":"policies.items.[INDEX].resources.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"policies.items.[INDEX].resources","typeLabel":"string[]"}},"required":["resourceType","actions","resources"],"type":"object","uniqueKey":"policies.items.[INDEX]","typeLabel":"object"},"maxItems":200,"type":"array","isRequired":true,"uniqueKey":"policies","typeLabel":"object[]"},"description":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"}},"required":["name","policies"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","policies":[{"actions":[],"resources":["\u003cstring>"]}],"description":"\u003cstring>"}}},"exampleType":"generated"}},"description":"RoleCreateBody","required":false,"exampleType":"generated"},"responses":{"5ec20c58-41a5-471e-a854-0bdb00861b68":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"integer","isRequired":true,"uniqueKey":"id","typeLabel":"integer"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"policies":{"items":{"properties":{"actions":{"items":{"enum":["All","DeploymentsManage","SignIn","DeploymentCreate","DeploymentRead","DeploymentUpdate","DeploymentDelete","SecretsManage","DownloadData","PlaygroundRead","SchemaRead","SchemaUpdate","SchemaUpdateDevBranches","APMRead","ChatHistoryRead","PreAggregationRead","PreAggregationBuild","AlertsCreate","AlertsRead","AlertsUpdate","AlertsDelete","AuditLogManage","BillingRead","SqlRunnerRead","DataAssetsRead","DataAssetsManage","CubeNetworkConnect","ReportRead","ReportEdit","ReportManage","WorkbookManage","WorkbookRead","WorkbookEdit","ChatThreadRead","AgentManage","AgentRead","AgentSpaceManage","AgentAdmin","DeploymentAgentRead","ScheduledTasksCreate","ScheduledTaskRead","ScheduledTasksRead","ScheduledTasksManage","OAuthIntegrationsManage","OAuthIntegrationsIssueTokens","McpToolsManage","AIBIDevelop","AIBIExplore","AIBIView","ChartPalettesManage","DashboardThemesManage","AIBIDeveloper","AIBIUser","AIBIViewer","EmbedDeploymentRead","EmbedDashboardRead","FolderRead","FolderEdit","FolderManage"],"type":"string","uniqueKey":"policies.items.[INDEX].actions.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","isRequired":true,"uniqueKey":"policies.items.[INDEX].actions","typeLabel":"enum\u003cstring>[]"},"resourceType":{"enum":["Global","Deployment","Report","ReportFolder","Agent","AgentSpace","Workbook","Dashboard","Folder","ChatThread","ScheduledTask"],"type":"string","isRequired":true,"uniqueKey":"policies.items.[INDEX].resourceType","typeLabel":"enum\u003cstring>"},"resources":{"items":{"type":"string","uniqueKey":"policies.items.[INDEX].resources.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"policies.items.[INDEX].resources","typeLabel":"string[]"}},"required":["resourceType","actions","resources"],"type":"object","uniqueKey":"policies.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"policies","typeLabel":"object[]"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"}},"required":["id","name","policies"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"name":"\u003cstring>","policies":[{"actions":["All"],"resourceType":"Global","resources":["\u003cstring>"]}],"description":"\u003cstring>"}}},"exampleType":"generated"}},"description":"","exampleType":"generated"},"a2cd6e94-b47f-40d7-aa6a-1d036c2930cc":{"description":"The name is one of the built-in role names, or a policy grants no action, names no resource, or scopes a `Deployment` to something that is not a deployment id.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"c272e4a3-491d-48f9-a775-e6f55a936075":{"description":"A role with that name already exists.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"5486a535-83a1-4621-9d33-d81817fae67c":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token authentication. Send `Authorization: Bearer \u003cYOUR_TOKEN>`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"bd7f78b9-135c-4ce0-b9db-2b2e2f5de545":{"url":"https://{tenant}.cubecloud.dev","description":"Your tenant host. Replace the whole host if you use a custom domain.","variables":{"tenant":{"default":"your-tenant","description":"Your Cube tenant subdomain"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Token authentication. Send `Authorization: Bearer \u003cYOUR_TOKEN>`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Token authentication. Send `Authorization: Bearer \u003cYOUR_TOKEN>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/api.yaml"},"subdomain":"cubed3","siteName":"Cube Documentation","title":"Create a custom role - Cube Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-14T14:24:00.425Z","originalFileLocation":"api-reference/roles/create-a-custom-role.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Cube Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cubed3/JtLYPWhDFrYGSK8W/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cubed3/JtLYPWhDFrYGSK8W/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cubed3/JtLYPWhDFrYGSK8W/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cubed3/JtLYPWhDFrYGSK8W/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cubed3/JtLYPWhDFrYGSK8W/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cubed3/JtLYPWhDFrYGSK8W/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cubed3/JtLYPWhDFrYGSK8W/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cubed3/JtLYPWhDFrYGSK8W/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cubed3/JtLYPWhDFrYGSK8W/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a custom role - Cube Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cube Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cube.dev/api-reference/roles/create-a-custom-role\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cubed3.mintlify.site/_mintlify/api/og/v2?division=Roles\u0026amp;title=Create+a+custom+role\u0026amp;theme=6d1e003873cec4de62649d7c\u0026amp;signature=0b223556f71eb9a98ce37f5308765a59a0ff8e0467738bc03ddc2dbe0f2e4142\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a custom role - Cube Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cubed3.mintlify.site/_mintlify/api/og/v2?division=Roles\u0026amp;title=Create+a+custom+role\u0026amp;theme=6d1e003873cec4de62649d7c\u0026amp;signature=0b223556f71eb9a98ce37f5308765a59a0ff8e0467738bc03ddc2dbe0f2e4142\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cubed3/JtLYPWhDFrYGSK8W/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cube Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5339CF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cube.dev/api-reference/roles/create-a-custom-role\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/roles/create-a-custom-role.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cube.dev/#organization\",\"name\":\"Cube Documentation\",\"url\":\"https://docs.cube.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cubed3/wCTntgEXVYYYnx4l/logo/light.svg?fit=max\u0026auto=format\u0026n=wCTntgEXVYYYnx4l\u0026q=85\u0026s=8bbf45ba64eac6116629064fac55aad7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cube.dev#website\",\"name\":\"Cube Documentation\",\"url\":\"https://docs.cube.dev\",\"publisher\":{\"@id\":\"https://docs.cube.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cube.dev/api-reference/roles/create-a-custom-role#webpage\",\"url\":\"https://docs.cube.dev/api-reference/roles/create-a-custom-role\",\"name\":\"Create a custom role\",\"dateModified\":\"2026-11-14T14:24:00.425Z\",\"isPartOf\":{\"@id\":\"https://docs.cube.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cube.dev/api-reference/roles/create-a-custom-role#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cube.dev/api-reference/roles/create-a-custom-role#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform Endpoints\",\"item\":\"https://docs.cube.dev/api-reference/deployments/get-deployments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Roles\",\"item\":\"https://docs.cube.dev/api-reference/roles/list-custom-roles\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a custom role\",\"item\":\"https://docs.cube.dev/api-reference/roles/create-a-custom-role\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cube.dev/api-reference/roles/create-a-custom-role#apireference\",\"headline\":\"Create a custom role\",\"name\":\"Create a custom role\",\"url\":\"https://docs.cube.dev/api-reference/roles/create-a-custom-role\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cube.dev/api-reference/roles/create-a-custom-role#webpage\"},\"dateModified\":\"2026-11-14T14:24:00.425Z\",\"publisher\":{\"@id\":\"https://docs.cube.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cube.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cube Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Cube Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/roles/create-a-custom-role.md","siteName":"Cube Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/introduction"}]},{"tab":"Admin","pages":[{"title":"Admin","href":"/admin/connect-to-data"}]},{"tab":"Embedding","pages":[{"title":"Embedding","href":"/embedding"}]},{"tab":"Reference","pages":[{"title":"Reference","href":"/reference/data-modeling/cube"}]},{"tab":"Cube Core","pages":[{"title":"Cube Core","href":"/cube-core"}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/recipes"}]},{"tab":"API","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"}]},{"group":"Core Data Endpoints","pages":[{"title":"JSON query","deprecated":null,"version":null,"openapi":"/api-reference/core-data.yaml post /v1/load","href":"/api-reference/data/json-query"},{"title":"SQL query","deprecated":null,"version":null,"openapi":"/api-reference/core-data.yaml post /v1/cubesql","href":"/api-reference/data/sql-query"},{"title":"Load Metadata","deprecated":null,"version":null,"openapi":"/api-reference/core-data.yaml get /v1/meta","href":"/api-reference/data/load-metadata"}]},{"group":"AI Endpoints","pages":[{"title":"Stream chat state","deprecated":null,"version":null,"openapi":"/api-reference/chat.yaml post /chat/stream-chat-state","href":"/api-reference/chat/stream-chat-state"},{"title":"Abort chat stream","deprecated":null,"version":null,"openapi":"/api-reference/chat.yaml post /chat/abort","href":"/api-reference/chat/abort-chat-stream"}]},{"group":"Platform Endpoints","pages":[{"group":"Deployments","pages":[{"title":"Get deployments","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments","href":"/api-reference/deployments/get-deployments"},{"title":"Get deployment","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}","href":"/api-reference/deployments/get-deployment"},{"title":"Update a deployment","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}","href":"/api-reference/deployments/update-a-deployment"},{"title":"Delete deployment","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}","href":"/api-reference/deployments/delete-deployment"},{"title":"Latest build/compile status for a branch (production build or dev-mode)","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/build-status","href":"/api-reference/deployments/latest-buildcompile-status-for-a-branch-production-build-or-dev-mode"},{"title":"Advance a deployment to a given onboarding step (e.g. after connecting a source)","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/creation-step/advance","href":"/api-reference/deployments/advance-a-deployment-to-a-given-onboarding-step-eg-after-connecting-a-source"},{"title":"Reset a deployment to the first onboarding step (project)","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/creation-step/reset","href":"/api-reference/deployments/reset-a-deployment-to-the-first-onboarding-step-project"},{"title":"Recent runtime logs (tail) for a deployment. With no `source`, reads both the production API / worker pods and the dev-mode worker, merged chronologically; scope with `?source=production` or `?source=dev`.","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/logs","href":"/api-reference/deployments/recent-runtime-logs-tail-for-a-deployment-with-no-`source`-reads-both-the-production-api-worker-pods-and-the-dev-mode-worker-merged-chronologically;-scope-with-`?source=production`-or-`?source=dev`"},{"title":"List the pods currently scheduled for a deployment","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/pods","href":"/api-reference/deployments/list-the-pods-currently-scheduled-for-a-deployment"},{"title":"Get deployment settings","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/settings","href":"/api-reference/deployments/get-deployment-settings"},{"title":"Deployment token","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/token","href":"/api-reference/deployments/deployment-token"},{"title":"List available Cube versions","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/versions","href":"/api-reference/deployments/list-available-cube-versions"}]},{"group":"Deployment Creation","pages":[{"title":"Create a deployment with an empty starter project and trigger its first build","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /build/api/v1/deployments","href":"/api-reference/deployment-creation/create-a-deployment-with-an-empty-starter-project-and-trigger-its-first-build"}]},{"group":"Environments","pages":[{"title":"Get deployment environments","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/environments","href":"/api-reference/environments/get-deployment-environments"},{"title":"Get deployment environment tokens","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/environments/{environmentId}/tokens","href":"/api-reference/environments/get-deployment-environment-tokens"},{"title":"Create deployment environment token","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/environments/{environmentId}/tokens","href":"/api-reference/environments/create-deployment-environment-token"},{"title":"Create deployment environment token for meta sync","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/environments/{environmentId}/tokens-for-meta-sync","href":"/api-reference/environments/create-deployment-environment-token-for-meta-sync"}]},{"group":"Env Variables","pages":[{"title":"List environment variables, including the database connection settings","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/env-vars","href":"/api-reference/env-variables/list-environment-variables-including-the-database-connection-settings"},{"title":"Set environment variables, including connecting or changing a database","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/env-vars","href":"/api-reference/env-variables/set-environment-variables-including-connecting-or-changing-a-database"}]},{"group":"Regions","pages":[{"title":"List regions","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/regions","href":"/api-reference/regions/list-regions"}]},{"group":"Data Model","pages":[{"title":"List a deployment's branches","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /build/api/v1/deployments/{deploymentId}/branches","href":"/api-reference/data-model/list-a-deployments-branches"},{"title":"Create a branch (optionally entering dev mode on it)","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /build/api/v1/deployments/{deploymentId}/branches","href":"/api-reference/data-model/create-a-branch-optionally-entering-dev-mode-on-it"},{"title":"Delete a branch","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /build/api/v1/deployments/{deploymentId}/branches","href":"/api-reference/data-model/delete-a-branch"},{"title":"Enable or disable a branch's staging environment","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /build/api/v1/deployments/{deploymentId}/branches/staging-environment","href":"/api-reference/data-model/enable-or-disable-a-branchs-staging-environment"},{"title":"Commit (and push) the active branch's pending changes","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /build/api/v1/deployments/{deploymentId}/commit","href":"/api-reference/data-model/commit-and-push-the-active-branchs-pending-changes"},{"title":"List the data-model source files for a deployment","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /build/api/v1/deployments/{deploymentId}/data-model/files","href":"/api-reference/data-model/list-the-data-model-source-files-for-a-deployment"},{"title":"Create or overwrite data-model source files","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /build/api/v1/deployments/{deploymentId}/data-model/files","href":"/api-reference/data-model/create-or-overwrite-data-model-source-files"},{"title":"Delete data-model source files","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /build/api/v1/deployments/{deploymentId}/data-model/files","href":"/api-reference/data-model/delete-data-model-source-files"},{"title":"Rename data-model source files","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /build/api/v1/deployments/{deploymentId}/data-model/files/rename","href":"/api-reference/data-model/rename-data-model-source-files"},{"title":"Compile a deployment's data model and report compilation errors","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /build/api/v1/deployments/{deploymentId}/data-model/validate","href":"/api-reference/data-model/compile-a-deployments-data-model-and-report-compilation-errors"},{"title":"Enter dev mode (switch to a branch)","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /build/api/v1/deployments/{deploymentId}/dev-mode","href":"/api-reference/data-model/enter-dev-mode-switch-to-a-branch"},{"title":"Exit dev mode","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /build/api/v1/deployments/{deploymentId}/dev-mode","href":"/api-reference/data-model/exit-dev-mode"},{"title":"Merge a branch into its parent branch (git-flow merge)","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /build/api/v1/deployments/{deploymentId}/merge","href":"/api-reference/data-model/merge-a-branch-into-its-parent-branch-git-flow-merge"},{"title":"Merge a branch straight into the deploy (default) branch","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /build/api/v1/deployments/{deploymentId}/merge-to-default","href":"/api-reference/data-model/merge-a-branch-straight-into-the-deploy-default-branch"},{"title":"Pull the latest for a branch from its remote and rebuild if changed","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /build/api/v1/deployments/{deploymentId}/pull","href":"/api-reference/data-model/pull-the-latest-for-a-branch-from-its-remote-and-rebuild-if-changed"}]},{"group":"Data Model Uploads","pages":[{"title":"Content hashes of the current data-model files (for upload diffing)","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /build/api/v1/deployments/{deploymentId}/data-model/file-hashes","href":"/api-reference/data-model-uploads/content-hashes-of-the-current-data-model-files-for-upload-diffing"},{"title":"Upload a single file into an open transaction","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /build/api/v1/deployments/{deploymentId}/data-model/upload/file","href":"/api-reference/data-model-uploads/upload-a-single-file-into-an-open-transaction"},{"title":"Finish the upload transaction (prune removed files) and trigger a build","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /build/api/v1/deployments/{deploymentId}/data-model/upload/finish","href":"/api-reference/data-model-uploads/finish-the-upload-transaction-prune-removed-files-and-trigger-a-build"},{"title":"Start a data-model upload transaction","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /build/api/v1/deployments/{deploymentId}/data-model/upload/start","href":"/api-reference/data-model-uploads/start-a-data-model-upload-transaction"}]},{"group":"GitHub","pages":[{"title":"List the user's GitHub App installations (orgs/accounts)","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/github/installations","href":"/api-reference/github/list-the-users-github-app-installations-orgsaccounts"},{"title":"List repositories accessible to a GitHub App installation","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/github/installations/{installationId}/repositories","href":"/api-reference/github/list-repositories-accessible-to-a-github-app-installation"},{"title":"List branches of a repository","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/github/repositories/{owner}/{repo}/branches","href":"/api-reference/github/list-branches-of-a-repository"},{"title":"Whether GitHub is linked, plus the link/install URLs","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/github/status","href":"/api-reference/github/whether-github-is-linked-plus-the-linkinstall-urls"}]},{"group":"GitHub Connection","pages":[{"title":"Connect a deployment to a GitHub repository and trigger a build","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /build/api/v1/deployments/{deploymentId}/github/connect","href":"/api-reference/github-connection/connect-a-deployment-to-a-github-repository-and-trigger-a-build"}]},{"group":"dbt Sync","pages":[{"title":"List dbt syncs for a deployment","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/dbt-sync","href":"/api-reference/dbt-sync/list-dbt-syncs-for-a-deployment"},{"title":"Start a dbt sync for a deployment","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/dbt-sync","href":"/api-reference/dbt-sync/start-a-dbt-sync-for-a-deployment"},{"title":"Get the status of a dbt sync","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/dbt-sync/{syncJobId}","href":"/api-reference/dbt-sync/get-the-status-of-a-dbt-sync"},{"title":"Cancel a running dbt sync","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/dbt-sync/{syncJobId}","href":"/api-reference/dbt-sync/cancel-a-running-dbt-sync"},{"title":"Get the files generated by a dbt sync that did not commit them","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/dbt-sync/{syncJobId}/generated-files","href":"/api-reference/dbt-sync/get-the-files-generated-by-a-dbt-sync-that-did-not-commit-them"},{"title":"Get the log of a dbt sync","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/dbt-sync/{syncJobId}/logs","href":"/api-reference/dbt-sync/get-the-log-of-a-dbt-sync"},{"title":"Get the result of a completed dbt sync","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/dbt-sync/{syncJobId}/result","href":"/api-reference/dbt-sync/get-the-result-of-a-completed-dbt-sync"}]},{"group":"Databricks Metric View Publication","pages":[{"title":"Start a Databricks Metric View publication preview","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/databricks-metric-view-previews","href":"/api-reference/databricks-metric-view-publication/start-a-databricks-metric-view-publication-preview"},{"title":"Get Databricks Metric View preview status","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/databricks-metric-view-previews/{previewId}","href":"/api-reference/databricks-metric-view-publication/get-databricks-metric-view-preview-status"},{"title":"Cancel a Databricks Metric View preview","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/databricks-metric-view-previews/{previewId}","href":"/api-reference/databricks-metric-view-publication/cancel-a-databricks-metric-view-preview"},{"title":"Get a completed Databricks Metric View preview result","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/databricks-metric-view-previews/{previewId}/result","href":"/api-reference/databricks-metric-view-publication/get-a-completed-databricks-metric-view-preview-result"}]},{"group":"Databricks Metric View Integration","pages":[{"title":"Get Databricks Metric View publication settings","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/databricks-metric-view-integrations/{dataSourceName}","href":"/api-reference/databricks-metric-view-integration/get-databricks-metric-view-publication-settings"},{"title":"Create or update Databricks Metric View publication settings","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/databricks-metric-view-integrations/{dataSourceName}","href":"/api-reference/databricks-metric-view-integration/create-or-update-databricks-metric-view-publication-settings"},{"title":"List Databricks Metric View publication runs","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/databricks-metric-view-integrations/{dataSourceName}/syncs","href":"/api-reference/databricks-metric-view-integration/list-databricks-metric-view-publication-runs"},{"title":"Start a Databricks Metric View publication run","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/databricks-metric-view-integrations/{dataSourceName}/syncs","href":"/api-reference/databricks-metric-view-integration/start-a-databricks-metric-view-publication-run"},{"title":"Get a Databricks Metric View publication run","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/databricks-metric-view-integrations/{dataSourceName}/syncs/{runId}","href":"/api-reference/databricks-metric-view-integration/get-a-databricks-metric-view-publication-run"},{"title":"Cancel a Databricks Metric View publication run","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/databricks-metric-view-integrations/{dataSourceName}/syncs/{runId}","href":"/api-reference/databricks-metric-view-integration/cancel-a-databricks-metric-view-publication-run"}]},{"group":"Snowflake Semantic View Sync","pages":[{"title":"Pull Snowflake Semantic Views into Cube","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/snowflake-semantic-view-pulls","href":"/api-reference/snowflake-semantic-view-sync/pull-snowflake-semantic-views-into-cube"},{"title":"Get Snowflake Semantic View pull status","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/snowflake-semantic-view-pulls/{syncJobId}","href":"/api-reference/snowflake-semantic-view-sync/get-snowflake-semantic-view-pull-status"},{"title":"Get the result of a completed Snowflake Semantic View pull","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/snowflake-semantic-view-pulls/{syncJobId}/result","href":"/api-reference/snowflake-semantic-view-sync/get-the-result-of-a-completed-snowflake-semantic-view-pull"},{"title":"Push Cube views to Snowflake Semantic Views","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/snowflake-semantic-view-syncs","href":"/api-reference/snowflake-semantic-view-sync/push-cube-views-to-snowflake-semantic-views"},{"title":"Get Snowflake Semantic View push status","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/snowflake-semantic-view-syncs/{syncJobId}","href":"/api-reference/snowflake-semantic-view-sync/get-snowflake-semantic-view-push-status"},{"title":"Get the result of a completed Snowflake Semantic View push","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/snowflake-semantic-view-syncs/{syncJobId}/result","href":"/api-reference/snowflake-semantic-view-sync/get-the-result-of-a-completed-snowflake-semantic-view-push"}]},{"group":"Folders","pages":[{"title":"List folders","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/folders","href":"/api-reference/folders/list-folders"},{"title":"Create a folder","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/folders","href":"/api-reference/folders/create-a-folder"},{"title":"Update a folder","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/folders/{folderId}","href":"/api-reference/folders/update-a-folder"},{"title":"Delete a folder","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/folders/{folderId}","href":"/api-reference/folders/delete-a-folder"},{"title":"List folder ancestors","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/folders/{folderId}/ancestors","href":"/api-reference/folders/list-folder-ancestors"}]},{"group":"Reports","pages":[{"title":"List reports","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/reports","href":"/api-reference/reports/list-reports"},{"title":"Create a report","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/reports","href":"/api-reference/reports/create-a-report"},{"title":"Create or update a report by publicId","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/reports/by-public-id/{publicId}","href":"/api-reference/reports/create-or-update-a-report-by-publicid"},{"title":"Get report","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/reports/{reportId}","href":"/api-reference/reports/get-report"},{"title":"Update a report","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/reports/{reportId}","href":"/api-reference/reports/update-a-report"},{"title":"Delete report","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/reports/{reportId}","href":"/api-reference/reports/delete-report"},{"title":"Connect a report to the calling spreadsheet","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/reports/{reportId}/connect-workbook","href":"/api-reference/reports/connect-a-report-to-the-calling-spreadsheet"},{"title":"Disconnect a report from one spot in a spreadsheet","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/reports/{reportId}/connect-workbook","href":"/api-reference/reports/disconnect-a-report-from-one-spot-in-a-spreadsheet"},{"title":"Read a report definition as editable JSON text","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/reports/{reportId}/file","href":"/api-reference/reports/read-a-report-definition-as-editable-json-text"},{"title":"Replace text in a report definition","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml patch /api/v1/deployments/{deploymentId}/reports/{reportId}/file","href":"/api-reference/reports/replace-text-in-a-report-definition"},{"title":"Refresh report","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/reports/{reportId}/refresh","href":"/api-reference/reports/refresh-report"}]},{"group":"External Documents","pages":[{"title":"Prove the caller has an external spreadsheet open","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/external-documents/{externalWorkbookId}/placement-proof","href":"/api-reference/external-documents/prove-the-caller-has-an-external-spreadsheet-open"},{"title":"List the Cube placements in an external spreadsheet","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/external-documents/{externalWorkbookId}/placements","href":"/api-reference/external-documents/list-the-cube-placements-in-an-external-spreadsheet"}]},{"group":"Workbooks","pages":[{"title":"Get workbooks","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/workbooks","href":"/api-reference/workbooks/get-workbooks"},{"title":"Create workbook","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/workbooks","href":"/api-reference/workbooks/create-workbook"},{"title":"Create or update a workbook by slug","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/workbooks/by-slug/{slug}","href":"/api-reference/workbooks/create-or-update-a-workbook-by-slug"},{"title":"Get workbook","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/workbooks/{workbookId}","href":"/api-reference/workbooks/get-workbook"},{"title":"Update a workbook","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/workbooks/{workbookId}","href":"/api-reference/workbooks/update-a-workbook"},{"title":"Delete workbook","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/workbooks/{workbookId}","href":"/api-reference/workbooks/delete-workbook"},{"title":"Create a workbook calculated field","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/calculated-fields","href":"/api-reference/workbooks/create-a-workbook-calculated-field"},{"title":"Update a workbook calculated field","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml patch /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/calculated-fields/{fieldId}","href":"/api-reference/workbooks/update-a-workbook-calculated-field"},{"title":"Delete a workbook calculated field","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/calculated-fields/{fieldId}","href":"/api-reference/workbooks/delete-a-workbook-calculated-field"},{"title":"Update workbook dashboard","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard","href":"/api-reference/workbooks/update-workbook-dashboard"},{"title":"Update published dashboard AI widget thread","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-thread","href":"/api-reference/workbooks/update-published-dashboard-ai-widget-thread"},{"title":"Read the dashboard draft as editable JSON text","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/file","href":"/api-reference/workbooks/read-the-dashboard-draft-as-editable-json-text"},{"title":"Replace text in the dashboard draft","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml patch /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/file","href":"/api-reference/workbooks/replace-text-in-the-dashboard-draft"},{"title":"Clone a workbook","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/duplicate","href":"/api-reference/workbooks/clone-a-workbook"},{"title":"Publish a dashboard","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/publish","href":"/api-reference/workbooks/publish-a-dashboard"}]},{"group":"Workbook Promotions","pages":[{"title":"Get workbook promotion provenance","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotion","href":"/api-reference/workbook-promotions/get-workbook-promotion-provenance"},{"title":"List workbook promotion destinations","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotion-links","href":"/api-reference/workbook-promotions/list-workbook-promotion-destinations"},{"title":"Preview a workbook promotion","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotion-previews","href":"/api-reference/workbook-promotions/preview-a-workbook-promotion"},{"title":"List workbook promotion history","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions","href":"/api-reference/workbook-promotions/list-workbook-promotion-history"},{"title":"Promote and publish a workbook","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions","href":"/api-reference/workbook-promotions/promote-and-publish-a-workbook"}]},{"group":"Dashboard Exports","pages":[{"title":"Export a dashboard as PNG or PDF","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/dashboard-exports","href":"/api-reference/dashboard-exports/export-a-dashboard-as-png-or-pdf"},{"title":"Get the status of a dashboard export","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/dashboard-exports/{jobId}","href":"/api-reference/dashboard-exports/get-the-status-of-a-dashboard-export"},{"title":"Download a completed dashboard export","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/dashboard-exports/{jobId}/download","href":"/api-reference/dashboard-exports/download-a-completed-dashboard-export"}]},{"group":"Notifications","pages":[{"title":"List scheduled notifications","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/notifications","href":"/api-reference/notifications/list-scheduled-notifications"},{"title":"Create a scheduled notification","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/notifications","href":"/api-reference/notifications/create-a-scheduled-notification"},{"title":"Get a scheduled notification","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/notifications/{id}","href":"/api-reference/notifications/get-a-scheduled-notification"},{"title":"Update a scheduled notification","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/notifications/{id}","href":"/api-reference/notifications/update-a-scheduled-notification"},{"title":"Delete a scheduled notification","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/notifications/{id}","href":"/api-reference/notifications/delete-a-scheduled-notification"},{"title":"List notification recipients","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/notifications/{id}/recipients","href":"/api-reference/notifications/list-notification-recipients"},{"title":"Add notification recipients","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/notifications/{id}/recipients","href":"/api-reference/notifications/add-notification-recipients"},{"title":"Remove notification recipients","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/notifications/{id}/recipients","href":"/api-reference/notifications/remove-notification-recipients"}]},{"group":"Scheduled Tasks","pages":[{"title":"List scheduled tasks","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/scheduled-tasks","href":"/api-reference/scheduled-tasks/list-scheduled-tasks"},{"title":"Create a scheduled task","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/scheduled-tasks","href":"/api-reference/scheduled-tasks/create-a-scheduled-task"},{"title":"Get a scheduled task","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}","href":"/api-reference/scheduled-tasks/get-a-scheduled-task"},{"title":"Update a scheduled task","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}","href":"/api-reference/scheduled-tasks/update-a-scheduled-task"},{"title":"Delete a scheduled task","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}","href":"/api-reference/scheduled-tasks/delete-a-scheduled-task"},{"title":"Run a scheduled task now","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}/run","href":"/api-reference/scheduled-tasks/run-a-scheduled-task-now"},{"title":"List a scheduled task's runs","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/scheduled-tasks/{taskId}/runs","href":"/api-reference/scheduled-tasks/list-a-scheduled-tasks-runs"}]},{"group":"Workspace","pages":[{"title":"List shared workspace items","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/shared-workspace","href":"/api-reference/workspace/list-shared-workspace-items"},{"title":"List workspace items","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/workspace","href":"/api-reference/workspace/list-workspace-items"},{"title":"Delete workspace items in bulk","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/workspace/bulk-delete","href":"/api-reference/workspace/delete-workspace-items-in-bulk"},{"title":"Move workspace items in bulk","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/workspace/bulk-move","href":"/api-reference/workspace/move-workspace-items-in-bulk"},{"title":"Move a workspace item","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/workspace/move","href":"/api-reference/workspace/move-a-workspace-item"}]},{"group":"Agents","pages":[{"title":"Get agent defaults","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/agent-defaults","href":"/api-reference/agents/get-agent-defaults"},{"title":"Get agent suggestions","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/agent-suggestions","href":"/api-reference/agents/get-agent-suggestions"}]},{"group":"Users","pages":[{"title":"Update my settings","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml patch /api/v1/users/me/settings","href":"/api-reference/users/update-my-settings"}]},{"group":"Users Admin","pages":[{"title":"Create user","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/users","href":"/api-reference/users-admin/create-user"},{"title":"Apply an action to many users","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/users/bulk","href":"/api-reference/users-admin/apply-an-action-to-many-users"},{"title":"Update user","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/users/{id}","href":"/api-reference/users-admin/update-user"},{"title":"Delete user","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/users/{id}","href":"/api-reference/users-admin/delete-user"},{"title":"List a user's roles","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/users/{id}/roles","href":"/api-reference/users-admin/list-a-users-roles"}]},{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/api-keys","href":"/api-reference/api-keys/create-api-key"},{"title":"Get API key","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/api-keys/{id}","href":"/api-reference/api-keys/get-api-key"},{"title":"Delete API key","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/api-keys/{id}","href":"/api-reference/api-keys/delete-api-key"}]},{"group":"Roles","pages":[{"title":"List custom roles","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/roles","href":"/api-reference/roles/list-custom-roles"},{"title":"Create a custom role","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/roles","href":"/api-reference/roles/create-a-custom-role"},{"title":"Get a custom role","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/roles/{roleId}","href":"/api-reference/roles/get-a-custom-role"},{"title":"Update a custom role","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/roles/{roleId}","href":"/api-reference/roles/update-a-custom-role"},{"title":"Delete a custom role","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/roles/{roleId}","href":"/api-reference/roles/delete-a-custom-role"},{"title":"List the users holding a role","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/roles/{roleId}/users","href":"/api-reference/roles/list-the-users-holding-a-role"},{"title":"Assign a role to a user","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/roles/{roleId}/users/{userId}","href":"/api-reference/roles/assign-a-role-to-a-user"},{"title":"Remove a role from a user","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/roles/{roleId}/users/{userId}","href":"/api-reference/roles/remove-a-role-from-a-user"}]},{"group":"User Attributes","pages":[{"title":"Get user attributes","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/user-attributes","href":"/api-reference/user-attributes/get-user-attributes"},{"title":"Create user attribute","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/user-attributes","href":"/api-reference/user-attributes/create-user-attribute"},{"title":"Update user attribute","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/user-attributes/{id}","href":"/api-reference/user-attributes/update-user-attribute"}]},{"group":"User Attribute Values","pages":[{"title":"Upsert user attribute value","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/user-attribute-values","href":"/api-reference/user-attribute-values/upsert-user-attribute-value"},{"title":"Get user attribute values","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/user-attribute-values/{userId}","href":"/api-reference/user-attribute-values/get-user-attribute-values"}]},{"group":"Tenant Settings","pages":[{"title":"Get tenant settings","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/tenant/settings","href":"/api-reference/tenant-settings/get-tenant-settings"},{"title":"Update tenant settings","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/tenant/settings","href":"/api-reference/tenant-settings/update-tenant-settings"}]},{"group":"OAuth Integrations","pages":[{"title":"List OAuth integrations","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/oauth-integrations","href":"/api-reference/oauth-integrations/list-oauth-integrations"},{"title":"Create OAuth integration","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/oauth-integrations","href":"/api-reference/oauth-integrations/create-oauth-integration"},{"title":"Get OAuth integration","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/oauth-integrations/{id}","href":"/api-reference/oauth-integrations/get-oauth-integration"},{"title":"Update OAuth integration","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/oauth-integrations/{id}","href":"/api-reference/oauth-integrations/update-oauth-integration"},{"title":"Delete OAuth integration","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/oauth-integrations/{id}","href":"/api-reference/oauth-integrations/delete-oauth-integration"}]},{"group":"User OAuth Tokens","pages":[{"title":"List user OAuth tokens","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/user-oauth-tokens","href":"/api-reference/user-oauth-tokens/list-user-oauth-tokens"},{"title":"Get user OAuth token","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/user-oauth-tokens/{integrationId}","href":"/api-reference/user-oauth-tokens/get-user-oauth-token"},{"title":"Revoke user OAuth token","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/user-oauth-tokens/{integrationId}","href":"/api-reference/user-oauth-tokens/revoke-user-oauth-token"},{"title":"Initiate OAuth flow","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/user-oauth-tokens/{integrationId}/initiate","href":"/api-reference/user-oauth-tokens/initiate-oauth-flow"}]},{"group":"OIDC Token Configs","pages":[{"title":"List OIDC token configs","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/oidc-token-configs","href":"/api-reference/oidc-token-configs/list-oidc-token-configs"},{"title":"Create OIDC token config","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/oidc-token-configs","href":"/api-reference/oidc-token-configs/create-oidc-token-config"},{"title":"Get OIDC token config","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/oidc-token-configs/{id}","href":"/api-reference/oidc-token-configs/get-oidc-token-config"},{"title":"Update OIDC token config","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/oidc-token-configs/{id}","href":"/api-reference/oidc-token-configs/update-oidc-token-config"},{"title":"Delete OIDC token config","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/oidc-token-configs/{id}","href":"/api-reference/oidc-token-configs/delete-oidc-token-config"}]},{"group":"App Theme","pages":[{"title":"Get app config","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/app-config","href":"/api-reference/app-theme/get-app-config"}]},{"group":"Embed","pages":[{"title":"Get an embeddable dashboard","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/embed/dashboard/{publicId}","href":"/api-reference/embed/get-an-embeddable-dashboard"},{"title":"Enable or disable signed embedding for a dashboard","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml patch /api/v1/embed/dashboard/{publicId}","href":"/api-reference/embed/enable-or-disable-signed-embedding-for-a-dashboard"},{"title":"List comment threads on an embeddable dashboard","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/embed/dashboard/{publicId}/comments","href":"/api-reference/embed/list-comment-threads-on-an-embeddable-dashboard"},{"title":"Post a comment on an embeddable dashboard","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/embed/dashboard/{publicId}/comments","href":"/api-reference/embed/post-a-comment-on-an-embeddable-dashboard"},{"title":"List embed users mentionable in a dashboard comment","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/embed/dashboard/{publicId}/comments/mentionable-users","href":"/api-reference/embed/list-embed-users-mentionable-in-a-dashboard-comment"},{"title":"Edit a comment on an embeddable dashboard","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml patch /api/v1/embed/dashboard/{publicId}/comments/{commentId}","href":"/api-reference/embed/edit-a-comment-on-an-embeddable-dashboard"},{"title":"Delete a comment on an embeddable dashboard","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/embed/dashboard/{publicId}/comments/{commentId}","href":"/api-reference/embed/delete-a-comment-on-an-embeddable-dashboard"},{"title":"Resolve or re-open a comment thread","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/embed/dashboard/{publicId}/comments/{commentId}/resolve","href":"/api-reference/embed/resolve-or-re-open-a-comment-thread"},{"title":"Run a python report over dashboard-filtered SQL","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/embed/dashboard/{publicId}/python-run","href":"/api-reference/embed/run-a-python-report-over-dashboard-filtered-sql"},{"title":"Generate an embed session","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/embed/generate-session","href":"/api-reference/embed/generate-an-embed-session"},{"title":"Revoke an embed session","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/embed/session/revoke","href":"/api-reference/embed/revoke-an-embed-session"},{"title":"Exchange a session for an embed token","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/embed/session/token","href":"/api-reference/embed/exchange-a-session-for-an-embed-token"}]},{"group":"Embed Tenants","pages":[{"title":"List embed tenants","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/embed-tenants","href":"/api-reference/embed-tenants/list-embed-tenants"},{"title":"Delete embed tenant","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/embed-tenants/{embedTenantName}","href":"/api-reference/embed-tenants/delete-embed-tenant"},{"title":"List embed groups","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/embed-tenants/{embedTenantName}/groups","href":"/api-reference/embed-tenants/list-embed-groups"},{"title":"Create an embed group","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/embed-tenants/{embedTenantName}/groups","href":"/api-reference/embed-tenants/create-an-embed-group"},{"title":"Get an embed group","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/embed-tenants/{embedTenantName}/groups/{id}","href":"/api-reference/embed-tenants/get-an-embed-group"},{"title":"Update an embed group","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml patch /api/v1/embed-tenants/{embedTenantName}/groups/{id}","href":"/api-reference/embed-tenants/update-an-embed-group"},{"title":"Delete an embed group","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/embed-tenants/{embedTenantName}/groups/{id}","href":"/api-reference/embed-tenants/delete-an-embed-group"},{"title":"List embed group members","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/embed-tenants/{embedTenantName}/groups/{id}/users","href":"/api-reference/embed-tenants/list-embed-group-members"},{"title":"Add embed group members","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/embed-tenants/{embedTenantName}/groups/{id}/users","href":"/api-reference/embed-tenants/add-embed-group-members"},{"title":"Remove embed group members","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/embed-tenants/{embedTenantName}/groups/{id}/users","href":"/api-reference/embed-tenants/remove-embed-group-members"},{"title":"Provision an embed user","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/embed-tenants/{embedTenantName}/user","href":"/api-reference/embed-tenants/provision-an-embed-user"},{"title":"List embed users","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/embed-tenants/{embedTenantName}/users","href":"/api-reference/embed-tenants/list-embed-users"},{"title":"Provision embed users in bulk","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/embed-tenants/{embedTenantName}/users","href":"/api-reference/embed-tenants/provision-embed-users-in-bulk"}]},{"group":"Dashboard Embed Access","pages":[{"title":"List workbooks accessible to an embed tenant","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/embed-tenants/{embedTenantName}/workbooks","href":"/api-reference/dashboard-embed-access/list-workbooks-accessible-to-an-embed-tenant"},{"title":"List a dashboard's embed access","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/embed-access","href":"/api-reference/dashboard-embed-access/list-a-dashboards-embed-access"},{"title":"Update a dashboard's embed access","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/embed-access","href":"/api-reference/dashboard-embed-access/update-a-dashboards-embed-access"}]},{"group":"Usage Analytics","pages":[{"title":"Issue a Cube API token for Usage Analytics","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/usage-analytics/token","href":"/api-reference/usage-analytics/issue-a-cube-api-token-for-usage-analytics"}]},{"group":"OpenAPI Spec","pages":[{"title":"Get the OpenAPI specification","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/spec","href":"/api-reference/openapi-spec/get-the-openapi-specification"}]},{"group":"Chat History","pages":[{"title":"List chat threads","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/chat-history/threads","href":"/api-reference/chat-history/list-chat-threads"},{"title":"Get a chat thread","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/chat-history/threads/{chatId}","href":"/api-reference/chat-history/get-a-chat-thread"}]},{"group":"Ossie Conversion","pages":[{"title":"Start an Apache Ossie conversion","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/ossie-conversions","href":"/api-reference/ossie-conversion/start-an-apache-ossie-conversion"},{"title":"Get an Apache Ossie conversion status","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/ossie-conversions/{conversionId}","href":"/api-reference/ossie-conversion/get-an-apache-ossie-conversion-status"},{"title":"Cancel an Apache Ossie conversion","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/ossie-conversions/{conversionId}","href":"/api-reference/ossie-conversion/cancel-an-apache-ossie-conversion"},{"title":"Get the files of an Apache Ossie conversion","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/ossie-conversions/{conversionId}/files","href":"/api-reference/ossie-conversion/get-the-files-of-an-apache-ossie-conversion"},{"title":"Get an Apache Ossie conversion result","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/ossie-conversions/{conversionId}/result","href":"/api-reference/ossie-conversion/get-an-apache-ossie-conversion-result"}]},{"group":"Report Deliveries","pages":[{"title":"List report deliveries","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/report-deliveries","href":"/api-reference/report-deliveries/list-report-deliveries"},{"title":"Create a report delivery","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/report-deliveries","href":"/api-reference/report-deliveries/create-a-report-delivery"},{"title":"Get a report delivery","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/report-deliveries/{id}","href":"/api-reference/report-deliveries/get-a-report-delivery"},{"title":"Update a report delivery","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml put /api/v1/deployments/{deploymentId}/report-deliveries/{id}","href":"/api-reference/report-deliveries/update-a-report-delivery"},{"title":"Delete a report delivery","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml delete /api/v1/deployments/{deploymentId}/report-deliveries/{id}","href":"/api-reference/report-deliveries/delete-a-report-delivery"},{"title":"Pause a report delivery","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/report-deliveries/{id}/pause","href":"/api-reference/report-deliveries/pause-a-report-delivery"},{"title":"Resume a paused report delivery","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/report-deliveries/{id}/resume","href":"/api-reference/report-deliveries/resume-a-paused-report-delivery"},{"title":"List runs of a report delivery","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/report-deliveries/{id}/runs","href":"/api-reference/report-deliveries/list-runs-of-a-report-delivery"},{"title":"Run a report delivery now","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml post /api/v1/deployments/{deploymentId}/report-deliveries/{id}/runs","href":"/api-reference/report-deliveries/run-a-report-delivery-now"},{"title":"Get a report delivery run","deprecated":null,"version":null,"openapi":"/api-reference/api.yaml get /api/v1/deployments/{deploymentId}/report-deliveries/{id}/runs/{runId}","href":"/api-reference/report-deliveries/get-a-report-delivery-run"}]},{"group":"Users (SCIM)","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/api-reference/scim.yaml get /scim/v2/Users","href":"/api-reference/scim-users/list-users"},{"title":"Create user","deprecated":null,"version":null,"openapi":"/api-reference/scim.yaml post /scim/v2/Users","href":"/api-reference/scim-users/create-user"},{"title":"Get user","deprecated":null,"version":null,"openapi":"/api-reference/scim.yaml get /scim/v2/Users/{id}","href":"/api-reference/scim-users/get-user"},{"title":"Replace user","deprecated":null,"version":null,"openapi":"/api-reference/scim.yaml put /scim/v2/Users/{id}","href":"/api-reference/scim-users/replace-user"},{"title":"Patch user","deprecated":null,"version":null,"openapi":"/api-reference/scim.yaml patch /scim/v2/Users/{id}","href":"/api-reference/scim-users/patch-user"},{"title":"Delete user","deprecated":null,"version":null,"openapi":"/api-reference/scim.yaml delete /scim/v2/Users/{id}","href":"/api-reference/scim-users/delete-user"}]},{"group":"Groups (SCIM)","pages":[{"title":"List groups","deprecated":null,"version":null,"openapi":"/api-reference/scim.yaml get /scim/v2/Groups","href":"/api-reference/scim-groups/list-groups"},{"title":"Create group","deprecated":null,"version":null,"openapi":"/api-reference/scim.yaml post /scim/v2/Groups","href":"/api-reference/scim-groups/create-group"},{"title":"Get group","deprecated":null,"version":null,"openapi":"/api-reference/scim.yaml get /scim/v2/Groups/{id}","href":"/api-reference/scim-groups/get-group"},{"title":"Replace group","deprecated":null,"version":null,"openapi":"/api-reference/scim.yaml put /scim/v2/Groups/{id}","href":"/api-reference/scim-groups/replace-group"},{"title":"Patch group","deprecated":null,"version":null,"openapi":"/api-reference/scim.yaml patch /scim/v2/Groups/{id}","href":"/api-reference/scim-groups/patch-group"},{"title":"Delete group","deprecated":null,"version":null,"openapi":"/api-reference/scim.yaml delete /scim/v2/Groups/{id}","href":"/api-reference/scim-groups/delete-group"}]}]}]}]},"basePath":"","title":"Create a custom role - Cube Documentation","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}