Skip to content

Commit b07de3b

Browse files
authored
Docs cleanup 2 (cube-js#10460)
* docs: add user attributes syncing via SCIM for Entra ID Add section documenting how to sync user attributes from Microsoft Entra to Cube via SCIM, including attribute creation, schema prefix, and mapping configuration. Made-with: Cursor * docs: add Viewer role requirement for MCP server Made-with: Cursor * docs: move Chart Prototyping to Embedding, Data Model to Data Modeling - Move Chart Prototyping (vizard) from workspace to embedding section - Move Data Model page to data-modeling section, rename to Data Model IDE - Update all references and add redirects for old paths Made-with: Cursor * docs: restructure pages, add scheduled refreshes and notifications docs - Move API keys from workspace to administration - Move Pricing from deployment to administration - Hide CLI from workspace navigation - Update scheduled refreshes page with full documentation - Add notifications page for email and Slack delivery - Update all references and add redirects for moved pages Made-with: Cursor
1 parent 3687c5f commit b07de3b

41 files changed

Lines changed: 292 additions & 72 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

β€Ždocs/content/product/administration/_meta.jsβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ export default {
33
"sso": "SSO & identity providers",
44
"ai": "AI",
55
"workspace": "Workspace",
6+
"api-keys": "API keys",
7+
"pricing": "Pricing",
68
"deployment": "Deployment",
79
"distribution": "Distribution"
810
}
File renamed without changes.

β€Ždocs/content/product/administration/deployment/_meta.jsβ€Ž

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ export default {
1010
"warm-up": "Deployment warm-up",
1111
"auto-suspension": "Auto-suspension",
1212
"scalability": "Scalability",
13-
"pricing": "Pricing",
1413
"support": "Support",
1514
"limits": "Limits",
1615
"core": "Cube Core"

β€Ždocs/content/product/administration/deployment/auto-suspension.mdxβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ response times to be significantly longer than usual.
117117
[ref-deployment-prod-cluster]:
118118
/product/deployment/cloud/deployment-types#production-cluster
119119
[ref-prod-multi-cluster]: /product/deployment/cloud/deployment-types#production-multi-cluster
120-
[ref-deployment-pricing]: /product/deployment/cloud/pricing
120+
[ref-deployment-pricing]: /product/administration/pricing
121121
[ref-monitoring]: /product/workspace/monitoring
122122
[ref-data-model]: /product/data-modeling/overview
123123
[ref-multitenancy]: /product/configuration/multitenancy

β€Ždocs/content/product/administration/deployment/deployment-types.mdxβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ You can try a Cube Cloud development instance by
5454
<InfoBox>
5555

5656
Available on [all paid plans](https://cube.dev/pricing).
57-
You can also choose a [deployment tier](/product/deployment/cloud/pricing#deployment-tiers).
57+
You can also choose a [deployment tier](/product/administration/pricing#deployment-tiers).
5858

5959
</InfoBox>
6060

β€Ždocs/content/product/administration/deployment/deployments.mdxβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,13 +165,13 @@ resource consumption in different scenarios.
165165
[ref-deployment-types]: /product/deployment/cloud/deployment-types
166166
[ref-dev-mode]: /product/workspace/dev-mode
167167
[ref-auto-sus]: /product/deployment/cloud/auto-suspension
168-
[ref-total-cost]: /product/deployment/cloud/pricing#total-cost-examples
168+
[ref-total-cost]: /product/administration/pricing#total-cost-examples
169169
[ref-data-source]: /product/configuration/data-sources
170170
[ref-duckdb]: /product/configuration/data-sources/duckdb
171171
[ref-data-model]: /product/data-modeling/overview
172172
[ref-dynamic-data-models]: /product/data-modeling/dynamic
173173
[ref-config-options]: /product/configuration#configuration-options
174-
[ref-data-model]: /product/workspace/data-model
174+
[ref-data-model]: /product/data-modeling/data-model-ide
175175
[ref-playground]: /product/workspace/playground
176176
[ref-environments]: /product/workspace/environments
177177
[ref-environments-prod]: /product/workspace/environments#production-environment

β€Ždocs/content/product/administration/deployment/limits.mdxβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,14 +98,14 @@ response.
9898
[ref-rest-api]: /product/apis-integrations/rest-api
9999
[ref-gql-api]: /product/apis-integrations/graphql-api
100100
[ref-deployment-types]: /product/deployment/cloud/deployment-types
101-
[ref-pricing]: /product/deployment/cloud/pricing
101+
[ref-pricing]: /product/administration/pricing
102102
[ref-query-history]: /product/workspace/query-history
103103
[ref-monitoring-integrations]: /product/workspace/monitoring
104104
[ref-dev-instance]:
105105
/product/deployment/cloud/deployment-types#development-instance
106106
[ref-prod-cluster]:
107107
/product/deployment/cloud/deployment-types#production-cluster
108108
[cube-contact-us]: https://cube.dev/contact
109-
[ref-query-history-tiers]: /product/deployment/cloud/pricing#query-history-tiers
109+
[ref-query-history-tiers]: /product/administration/pricing#query-history-tiers
110110
[ref-audit-log]: /product/workspace/audit-log
111-
[ref-monitoring-integrations-tiers]: /product/deployment/cloud/pricing#monitoring-integrations-tiers
111+
[ref-monitoring-integrations-tiers]: /product/administration/pricing#monitoring-integrations-tiers

β€Ždocs/content/product/administration/deployment/support.mdxβ€Ž

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,9 @@ We prioritize support requests based on their severity, as follows:
106106
[ref-docs-intro]: /product/introduction
107107
[cube-webinars]: https://cube.dev/events
108108
[cube-slack]: https://slack.cube.dev
109-
[ref-cloud-pricing]: /product/deployment/cloud/pricing
110-
[ref-free-tier]: /product/deployment/cloud/pricing#free
111-
[ref-starter-tier]: /product/deployment/cloud/pricing#starter
112-
[ref-premium-tier]: /product/deployment/cloud/pricing#premium
113-
[ref-enterprise-tier]: /product/deployment/cloud/pricing#enterprise
114-
[ref-enterprise-premier-tier]: /product/deployment/cloud/pricing#enterprise-premier
109+
[ref-cloud-pricing]: /product/administration/pricing
110+
[ref-free-tier]: /product/administration/pricing#free
111+
[ref-starter-tier]: /product/administration/pricing#starter
112+
[ref-premium-tier]: /product/administration/pricing#premium
113+
[ref-enterprise-tier]: /product/administration/pricing#enterprise
114+
[ref-enterprise-premier-tier]: /product/administration/pricing#enterprise-premier
File renamed without changes.
Lines changed: 54 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# SCIM provisioning with Microsoft Entra ID
22

33
With SCIM (System for Cross-domain Identity Management) enabled, you can
4-
automate user provisioning in Cube Cloud and keep user groups synchronized
4+
automate user provisioning in Cube and keep user groups synchronized
55
with Microsoft Entra ID (formerly Azure Active Directory).
66

77
<InfoBox>
@@ -16,49 +16,49 @@ Before proceeding, ensure you have the following:
1616

1717
- Microsoft Entra SAML authentication already configured. If not, complete
1818
the [SAML setup][ref-saml] first.
19-
- Admin permissions in Cube Cloud.
19+
- Admin permissions in Cube.
2020
- Sufficient permissions in Microsoft Entra to manage Enterprise Applications.
2121

22-
## Enable SCIM provisioning in Cube Cloud
22+
## Enable SCIM provisioning in Cube
2323

2424
Before configuring SCIM in Microsoft Entra, you need to enable SCIM
25-
provisioning in Cube Cloud:
25+
provisioning in Cube:
2626

2727
1. In Cube, navigate to <Btn>Admin β†’ Settings</Btn>.
2828
2. In the <Btn>SAML</Btn> section, enable <Btn>SCIM Provisioning</Btn>.
2929

30-
## Generate an API key in Cube Cloud
30+
## Generate an API key in Cube
3131

32-
To allow Entra ID to communicate with Cube Cloud via SCIM, you'll need to
32+
To allow Entra ID to communicate with Cube via SCIM, you'll need to
3333
create a dedicated API key:
3434

35-
1. In Cube Cloud, navigate to <Btn>Settings β†’ API Keys</Btn>.
35+
1. In Cube, navigate to <Btn>Settings β†’ API Keys</Btn>.
3636
2. Create a new API key. Give it a descriptive name such as **Entra SCIM**.
3737
3. Copy the generated key and store it securely β€” you'll need it in the
3838
next step.
3939

4040
## Set up provisioning in Microsoft Entra
4141

42-
This section assumes you already have a Cube Cloud Enterprise Application
42+
This section assumes you already have a Cube Enterprise Application
4343
in Microsoft Entra. If you haven't created one yet, follow the
4444
[SAML setup guide][ref-saml] first.
4545

4646
1. Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com).
4747
2. Go to <Btn>Applications β†’ Enterprise Applications</Btn> and open your
48-
Cube Cloud application.
48+
Cube application.
4949
3. Navigate to <Btn>Manage β†’ Provisioning</Btn>.
5050
4. Set the <Btn>Provisioning Mode</Btn> to **Automatic**.
5151
5. Under <Btn>Admin Credentials</Btn>, fill in the following:
52-
- **Tenant URL** β€” Your Cube Cloud deployment URL with `/api/scim/v2`
52+
- **Tenant URL** β€” Your Cube deployment URL with `/api/scim/v2`
5353
appended. For example: `https://your-deployment.cubecloud.dev/api/scim/v2`
5454
- **Secret Token** β€” The API key you generated in the previous step.
5555
6. Click <Btn>Test Connection</Btn> to verify that Entra ID can reach
56-
Cube Cloud. Proceed once the test is successful.
56+
Cube. Proceed once the test is successful.
5757

5858
## Configure attribute mappings
5959

6060
Next, configure which user and group attributes are synchronized with
61-
Cube Cloud:
61+
Cube:
6262

6363
1. In the <Btn>Mappings</Btn> section, select the object type you want to
6464
configure β€” either users or groups.
@@ -71,8 +71,49 @@ Cube Cloud:
7171

7272
Users provisioned via SCIM will receive the Explorer role.
7373
To grant admin permissions, update the user's role manually in
74-
Cube Cloud under <Btn>Team & Security</Btn>.
74+
Cube under <Btn>Team & Security</Btn>.
7575

7676
</InfoBox>
7777

78+
## Syncing user attributes
79+
80+
You can sync [user attributes][ref-user-attributes] from Microsoft Entra to
81+
Cube via SCIM, allowing you to centralize user management in Entra.
82+
83+
### Create a user attribute in Cube
84+
85+
In Cube, navigate to <Btn>Admin β†’ Settings β†’ User Attributes</Btn> and
86+
create a new attribute. Take note of the attribute **reference** name β€” you will
87+
need it when configuring Entra.
88+
89+
### Create an Entra user attribute
90+
91+
1. In the [Microsoft Entra admin center](https://entra.microsoft.com), navigate
92+
to <Btn>Applications β†’ Enterprise Applications</Btn> and open your Cube
93+
application.
94+
2. Go to <Btn>Manage β†’ Provisioning β†’ Mappings</Btn>.
95+
3. Select the user mapping you want to add the attribute to.
96+
4. At the bottom of the page, select <Btn>Show advanced options</Btn>.
97+
5. Select <Btn>Edit attribute list for customappsso</Btn>.
98+
6. Add a new attribute with the following settings:
99+
- **Name** β€” The reference of the attribute you created in Cube,
100+
prefixed with `urn:cube:params:1.0:UserAttribute:`.
101+
For example, for an attribute with the reference `country`, enter
102+
`urn:cube:params:1.0:UserAttribute:country`.
103+
- **Type** β€” Select the matching type (`string` or `integer`).
104+
7. Save the changes.
105+
106+
### Create attribute mapping
107+
108+
1. After saving, click <Btn>Yes</Btn> when prompted.
109+
2. In the <Btn>Attribute Mapping</Btn> page, click <Btn>Add New Mapping</Btn>.
110+
3. In the <Btn>Target attribute</Btn> dropdown, select the attribute you created
111+
in the previous step.
112+
4. Configure the source mapping to the appropriate Entra field.
113+
5. Click <Btn>OK</Btn>, then <Btn>Save</Btn>.
114+
115+
The next time the Entra application syncs, the attribute values will be
116+
provisioned as [user attributes][ref-user-attributes] in Cube.
117+
78118
[ref-saml]: /product/administration/sso/microsoft-entra-id/saml
119+
[ref-user-attributes]: /product/administration/users-and-permissions/user-attributes

0 commit comments

Comments
Β (0)