Skip to content

docs: Kerberos & NTLM authentication for DAX/MDX APIs #9503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 30, 2025
Merged

docs: Kerberos & NTLM authentication for DAX/MDX APIs #9503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c9b0413
docs: Kerberos & NTLM authentication
igorlukanin Apr 23, 2025
bce22bf
Note
igorlukanin Apr 24, 2025
e30a3d9
Fix
igorlukanin Apr 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions docs/pages/product/apis-integrations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,9 @@ tools][ref-viz-tools]:
| Method | ✅ Supported in |
| --- | --- |
| [User name and password][ref-auth-user-pass] | [DAX API][ref-dax-api]<br/>[MDX API][ref-mdx-api]<br/>[Semantic Layer Sync][ref-sls]<br/>[SQL API][ref-sql-api] |
| [Kerberos][ref-auth-kerberos] and [NTLM][ref-auth-ntlm] | [DAX API][ref-dax-api]<br/>[MDX API][ref-mdx-api] |
| [Identity provider][ref-auth-idp] | [Cube Cloud for Excel][ref-cube-cloud-for-excel]<br/>[Cube Cloud for Sheets][ref-cube-cloud-for-sheets] |
| [Access token][ref-auth-tokens] | [REST API][ref-rest-api]<br/>[GraphQL API][ref-graphql-api]<br/>[AI API][ref-ai-api] |
| [JSON Web Token][ref-auth-jwt] | [REST API][ref-rest-api]<br/>[GraphQL API][ref-graphql-api]<br/>[AI API][ref-ai-api] |

## Management APIs

Expand Down Expand Up @@ -96,6 +97,8 @@ API][ref-orchestration-api].
[ref-excel]: /product/configuration/visualization-tools/excel
[ref-sheets]: /product/configuration/visualization-tools/google-sheets
[ref-tableau]: /product/configuration/visualization-tools/tableau
[ref-auth-user-pass]: /product/auth#user-name-and-password
[ref-auth-idp]: /product/auth#identity-provider
[ref-auth-tokens]: /product/auth#access-token
[ref-auth-user-pass]: /product/auth/methods/name-password
[ref-auth-idp]: /product/auth/methods/identity-provider
[ref-auth-jwt]: /product/auth/methods/jwt
[ref-auth-kerberos]: /product/auth/methods/kerberos
[ref-auth-ntlm]: /product/auth/methods/ntlm
33 changes: 11 additions & 22 deletions docs/pages/product/apis-integrations/dax-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,38 +49,27 @@ variable to `false` to disable this behavior.

## Authentication

The DAX API supports the user name and password authentication method.
The DAX API supports [Kerberos][ref-kerberos] and [NTLM][ref-ntlm] authentication
methods.

## Using DAX API with Power BI
While NTLM can be used for testing purposes, we strongly recommend configuring
Kerberos for production environments.

## Data modeling

<InfoBox>

The DAX API works only with [views][ref-views], not cubes.
The DAX API only exposes [views][ref-views], not cubes.

</InfoBox>

### Connection methods

Power BI provides [three methods][link-powerbi-connection] to connect to data
sources: _live connection_, _DirectQuery_, and _import mode_.

| | Live connection | DirectQuery | <nobr>Import mode</nobr> |
| --- | --- | --- | --- |
| Data location | 🟢 Data source | 🟢 Data source | 🟡 Power BI |
| Data freshness | 🟢 Real-time data | 🟢 Real-time data | 🟡 Stale copy |
| Semantic model | <nobr>🟢 Up-to-date model</nobr> | 🟡 Stale copy | 🟡 Stale copy |
| Queries | <nobr>🟢 Composed in UI</nobr><br/><nobr>🔴 No custom queries</nobr> | <nobr>🟢 Composed in UI</nobr><br/><nobr>🟢 Custom queries</nobr> | <nobr>🟢 Composed in UI</nobr><br/><nobr>🟢 Custom queries</nobr> |

__It's recommended to use a _live connection_ whenever possible.__ Use _DirectQuery_
if you need to write your own DAX queries, but be aware that you must manually
synchronize semantic models as they evolve. _Import mode_ is not recommended, as
it removes the benefits of using a semantic layer.


[ref-powerbi]: /product/configuration/visualization-tools/powerbi
[link-dax]: https://learn.microsoft.com/en-us/dax/
[ref-sql-api]: /product/apis-integrations/sql-api
[ref-ref-dax-api]: /product/apis-integrations/dax-api/reference
[ref-views]: /product/data-modeling/concepts#views
[link-powerbi-connection]: https://learn.microsoft.com/en-us/power-bi/connect-data/service-live-connect-dq-datasets
[ref-time-dimensions]: /product/data-modeling/concepts#time-dimensions
[ref-time-dimensions]: /product/data-modeling/concepts#time-dimensions
[ref-kerberos]: /product/auth/methods/kerberos
[ref-ntlm]: /product/auth/methods/ntlm
[ref-power-bi]: /product/configuration/visualization-tools/powerbi#connecting-from-power-bi
2 changes: 1 addition & 1 deletion ...pages/product/apis-integrations/javascript-sdk/reference/cubejs-client-core.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ to give each series a unique prefix. This is useful for `blending queries` which
{
member: 'Stores.read',
operator: 'equals',
value: ['true'],
values: ['true'],
},
],
},
Expand Down
Loading