Admin

Operations

Add Power BI Encryption Key

Adds an encryption key for Power BI workspaces assigned to a capacity.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 600 requests per hour at maximum.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Capacities AssignWorkspacesToCapacity

Assigns the provided workspaces to the specified capacity.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Capacities UnassignWorkspacesFromCapacity

Unassigns the provided workspaces from capacity.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Dashboards GetDashboardsAsAdmin

Returns a list of dashboards for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Dashboards GetDashboardsInGroupAsAdmin

Returns a list of dashboards from the specified workspace.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Dashboards GetTilesAsAdmin

Returns a list of tiles within the specified dashboard.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Dataflows ExportDataflowAsAdmin

Exports the specified dataflow definition to a .json file.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All
Application only and delegated permissions are supported.
To set the permissions scope, see Register an app.

Dataflows GetDataflowDatasourcesAsAdmin

Returns a list of datasources for the specified dataflow.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All
Application only and delegated permissions are supported.
To set the permissions scope, see Register an app.

Dataflows GetDataflowsAsAdmin

Returns a list of dataflows for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Dataflows GetDataflowsInGroupAsAdmin

Returns a list of dataflows from the specified workspace.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Dataflows GetUpstreamDataflowsInGroupAsAdmin

Returns a list of upstream dataflows for the specified dataflow.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Datasets GetDatasetsAsAdmin

Returns a list of datasets for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API processes each request for 2 seconds, in the mean time other requests will be queued.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Datasets GetDatasetsInGroupAsAdmin

Returns a list of datasets from the specified workspace.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Datasets GetDatasourcesAsAdmin

Returns a list of datasources for the specified dataset.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API processes each request for 0.5 seconds, in the mean time other requests will be queued.

Required scope: Tenant.Read.All
Application only and delegated permissions are supported.
To set the permissions scope, see Register an app.

Get Capacities As Admin

Returns a list of capacities for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Get Power BI Encryption Keys

Returns the encryption keys for the tenant.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Groups AddUserAsAdmin

Grants user permissions to the specified workspace.
Note: This API is currently limited to updating workspaces in the new workspace experience. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Groups DeleteUserAsAdmin

Removes user permissions to the specified workspace.
Note: This API is currently limited to updating workspaces in the new workspace experience. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Groups GetGroupsAsAdmin

Returns a list of workspaces for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Groups RestoreDeletedGroupAsAdmin

Restores a deleted workspace.
Note: This API is currently limited to restoring workspaces in the new workspace experience. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Groups UpdateGroupAsAdmin

Updates the specified workspace properties.
Note: This API is currently limited to updating workspaces in the new workspace experience. Only name and description can be updated, and name must be unique inside an organization. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Imports GetImportsAsAdmin

Returns a list of imports for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Patch Capacity As Admin

Changes the specific capacity information. Currently, only supports changing the capacity encryption key
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Reports GetReportsAsAdmin

Returns a list of reports for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Reports GetReportsInGroupAsAdmin

Returns a list of reports from the specified workspace.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

Rotate Power BI Encryption Key

Rotate the encryption key for Power BI workspaces assigned to a capacity.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 600 requests per hour at maximum.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.