Skip to main content

Admin API Reference

Developer

The Admin API allows you to programmatically manage users, roles, organizational units (OUs), and content within your DataCentral Tenant. This is useful for synchronizing users from an external HR system or automating the provisioning of new customers.

All endpoints require authentication using your Tenant API Key as a Bearer token in the Authorization header.

1. Users​

Manage the identities that can log into your Tenant.

List Users​

GET /v1/users

Returns a paginated list of users in the Tenant.

Create User​

POST /v1/users

Creates a new user.

Request Body:

{
  "type": "AzureAD",
  "email": "user@company.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "roles": ["User", "ReportViewer"],
  "organizationUnits": ["ou-sales"]
}

Valid type values: AzureAD, AzureADExternal, UserPass, MobileID.

Get User​

GET /v1/users/{userId}

Returns the details of a specific user.

Update User​

PATCH /v1/users/{userId}

Updates a user's details, roles, or OU memberships.

Delete User​

DELETE /v1/users/{userId}

Permanently removes a user from the Tenant.

2. Roles​

Manage System, Report, and RLS roles.

List Roles​

GET /v1/roles

Returns a list of all roles in the Tenant.

Create Role​

POST /v1/roles

Creates a new role.

Request Body:

{
  "name": "EMEA Sales",
  "type": "RLS",
  "code": "Region_EMEA",
  "description": "Access to EMEA sales data"
}

Valid type values: System, Report, RLS.

3. Organizational Units (OUs)​

Manage the hierarchical structure of your Tenant.

List OUs​

GET /v1/organization-units

Returns a list of all OUs.

Create OU​

POST /v1/organization-units

Creates a new Organizational Unit.

Request Body:

{
  "name": "Region - EMEA",
  "parentId": "root",
  "entraGroupId": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"
}

(Note: entraGroupId is optional and used for Microsoft Graph synchronization.)

Sync OU​

POST /v1/organization-units/{ouId}/sync

Triggers an immediate synchronization with the linked Entra ID Security Group.

4. Items (Power BI Content)​

Manage the Power BI reports, dashboards, and apps imported into your Tenant.

List Items​

GET /v1/items

Returns a list of all Power BI items in the Tenant.

Create Item​

POST /v1/items

Imports a new Power BI item into the Tenant.

Request Body:

{
  "type": "Report",
  "workspaceId": "w1x2y3z4-...",
  "reportId": "r1a2b3c4-...",
  "displayName": "Executive Dashboard",
  "roles": ["Executive Viewers"],
  "additionalData": [
    { "type": "dataset", "id": "d1e2f3g4-...", "hasRls": true }
  ]
}

Automate actions and manage secure sharing links.

List Tasks​

GET /v1/tasks

Returns a list of all automated tasks (Webhooks or DAX Queries) configured in the Tenant.

GET /v1/links

Returns a list of all active Report Keys and Slideshow links.