Admin

Operations

Add Power BI Encryption Key

Adds an encryption key for Power BI workspaces assigned to a capacity.

Permissions

The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 600 requests per hour.

Apps GetAppsAsAdmin

Returns a list of apps in the organization. This is a preview API call.

The query parameter $top is required.

Permissions

Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Apps GetAppUsersAsAdmin

Returns a list of users that have access to the specified app. This is a preview API call.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Capacities AssignWorkspacesToCapacity

Assigns the specified workspaces to the specified Premium capacity.

Permissions

The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Capacities GetCapacityUsersAsAdmin

Returns a list of users that have access to the specified workspace. This is a preview API call.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Capacities UnassignWorkspacesFromCapacity

Unassigns the specified workspaces from capacity.

Permissions

The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Dashboards GetDashboardsAsAdmin

Returns a list of dashboards for the organization.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Dashboards GetDashboardsInGroupAsAdmin

Returns a list of dashboards from the specified workspace.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Dashboards GetDashboardSubscriptionsAsAdmin

Returns a list of subscriptions along with subscribees that the dashboard subscribed to. This is a preview API call.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Dashboards GetDashboardUsersAsAdmin

Returns a list of users that have access to the specified dashboard. This is a preview API call.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Dashboards GetTilesAsAdmin

Returns a list of tiles within the specified dashboard.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Dataflows ExportDataflowAsAdmin

Exports the definition for the specified dataflow to a JSON file.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Dataflows GetDataflowDatasourcesAsAdmin

Returns a list of data sources for the specified dataflow.

Deleted datasources will still appear in the response. This may include both cloud and on-premise data gateway sources. For more information see Dataflows considerations and limitations.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Dataflows GetDataflowsAsAdmin

Returns a list of dataflows for the organization.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Dataflows GetDataflowsInGroupAsAdmin

Returns a list of dataflows from the specified workspace.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Dataflows GetDataflowUsersAsAdmin

Returns a list of users that have access to the specified dataflow. This is a preview API call.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Dataflows GetUpstreamDataflowsInGroupAsAdmin

Returns a list of upstream dataflows for the specified dataflow.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Datasets GetDatasetsAsAdmin

Returns a list of datasets for the organization.

Each request takes two seconds to process, during which time other requests are queued.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Datasets GetDatasetsInGroupAsAdmin

Returns a list of datasets from the specified workspace.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Datasets GetDatasetToDataflowsLinksInGroupAsAdmin

Returns a list of upstream dataflows for datasets from the specified workspace.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Datasets GetDatasetUsersAsAdmin

Returns a list of users that have access to the specified dataset. This is a preview API call.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Datasets GetDatasourcesAsAdmin

Returns a list of data sources for the specified dataset.

Each request takes 0.5 seconds to process, during which time other requests are queued.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Get Activity Events

Returns a list of audit activity events for a tenant.

Provide either a continuation token or both a start and end date time. StartDateTime and EndDateTime must be in the same UTC day and should be wrapped in single quotes.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

  • Maximum 200 requests per hour.
  • Activity logging isn't supported for Microsoft Cloud Deutschland.
Get Capacities As Admin

Returns a list of capacities for the organization.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Get Power BI Encryption Keys

Returns the encryption keys for the tenant.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Get Refreshable For Capacity

Returns the specified refreshable for the specified capacity that the user has access to.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Get Refreshables

Returns a list of refreshables for the organization within a capacity.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Get Refreshables For Capacity

Returns a list of refreshables for the specified capacity that the user has access to.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Groups AddUserAsAdmin

Grants user permissions to the specified workspace.

This API call only supports updating workspaces in the new workspace experience and adding a user principle.

Permissions

The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).

Required scope

Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Groups DeleteUserAsAdmin

Removes user permissions from the specified workspace.

This API call only supports updating workspaces in the new workspace experience and adding a user principle.

Permissions

The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).

Required scope

Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Groups GetGroupAsAdmin

Returns a workspace for the organization.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Groups GetGroupsAsAdmin

Returns a list of workspaces for the organization.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Groups GetGroupUsersAsAdmin

Returns a list of users that have access to the specified workspace. This is a preview API call.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Groups GetUnusedArtifactsAsAdmin

Returns a list of datasets that have not been used within 30 days for the specified workspace (Preview).

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Groups RestoreDeletedGroupAsAdmin

Restores a deleted workspace.

This API call only supports restoring workspaces in the new workspace experience.

Permissions

The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).

Required scope

Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Groups UpdateGroupAsAdmin

Updates the properties of the specified workspace.

This API call call only updates workspaces in the new workspace experience. Only the name and description can be updated. The name must be unique inside an organization.

Permissions

The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).

Required scope

Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Imports GetImportsAsAdmin

Returns a list of imports for the organization.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

InformationProtection RemoveLabelsAsAdmin

Remove sensitivity labels from artifacts by artifact ID.

For a usage example, see Set or remove sensitivity labels.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).
  • The admin user must have sufficient usage rights to delete labels.

Required scope

Tenant.ReadWrite.All

Limitations

  • Maximum 25 requests per hour.
  • Each request can update up to 2000 artifacts.
InformationProtection SetLabelsAsAdmin

Set sensitivity labels on content in Power BI by artifact ID.

To set a sensitivity label using this API, the admin user or the delegated user (if provided) must have the label included in their label policy. For a usage example, see Set or remove sensitivity labels.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).
  • The admin user and the delegated user (if provided) must have sufficient usage rights to set labels.

Required scope

Tenant.ReadWrite.All

Limitations

  • Maximum 25 requests per hour.
  • Each request can update up to 2000 artifacts.
Patch Capacity As Admin

Changes specific capacity information. Currently, this API call only supports changing the capacity's encryption key.

Permissions

The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Pipelines DeleteUserAsAdmin

Removes user permissions from a specified deployment pipeline.

Permissions

The user must have administrator rights.

Required scope

Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Pipelines GetPipelinesAsAdmin

Returns a list of deployment pipelines for the organization.

Permissions

The user must have administrator rights or authenticate using a service principal.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Pipelines GetPipelineUsersAsAdmin

Returns a list of users that have access to a specified deployment pipeline.

Permissions

The user must have administrator rights or authenticate using a service principal.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Pipelines UpdateUserAsAdmin

Grants user permissions to a specified deployment pipeline.

Permissions

The user must have administrator rights.

Required scope

Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Reports GetReportsAsAdmin

Returns a list of reports for the organization.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Reports GetReportsInGroupAsAdmin

Returns a list of reports from the specified workspace.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Reports GetReportSubscriptionsAsAdmin

Returns a list of subscriptions along with subscribees that the report subscribed to. This is a preview API call.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Reports GetReportUsersAsAdmin

Returns a list of users that have access to the specified report. This is a preview API call.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Rotate Power BI Encryption Key

Rotate the encryption key for Power BI workspaces assigned to a capacity.

Permissions

The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 600 requests per hour.

Users GetUserArtifactAccessAsAdmin

Returns a list of artifacts that the given user have access to (Preview).

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

Users GetUserSubscriptionsAsAdmin

Returns a list of subscriptions that the given user has subscribed to (Preview).

userId

  • The UserId can be userGraphId or UserPrincipalName

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

WorkspaceInfo GetModifiedWorkspaces

Gets a list of workspace IDs in the organization. This is a preview API call.

If the optional modifiedSince parameter is set to a date-time, only the IDs of workspaces that changed after that date-time are returned. If the modifiedSince parameter isn't used, the IDs of all workspaces in the organization are returned. The date-time specified by the modifiedSince parameter must be in the range of 30 minutes (to allow workspace changes to take effect) to 30 days prior to the current time.

Permissions

The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 30 requests per hour.

WorkspaceInfo GetScanResult

Gets the scan result for the specified scan. This is a preview API call.

Only make this API call after a successful GetScanStatus API call. The scan result will remain available for 24 hours.

Permissions

The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 500 requests per hour.

WorkspaceInfo GetScanStatus

Gets the scan status for the specified scan. This is a preview API call.

Permissions

The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 10,000 requests per hour.

WorkspaceInfo PostWorkspaceInfo

Initiates a call to receive metadata for the requested list of workspaces. This is a preview API call.

Permissions

The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

  • Maximum 500 requests per hour.
  • Maximum 16 simultaneous requests.