Admin - Capacities GetCapacityUsersAsAdmin

Returns a list of users that have access to the specified workspace.

Permissions

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

When running under service prinicipal authentication, an app must not have any admin-consent required premissions for Power BI set on it in the Azure portal.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

Relevant only when authenticating via a standard delegated admin access token. Must not be present when authentication via a service principal is used.

GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/users

URI Parameters

Name In Required Type Description
capacityId
path True
  • string
uuid

The capacity ID

Responses

Name Type Description
200 OK

OK

Definitions

CapacityUser

A Power BI user access right entry for a capacity

capacityUserAccessRight

The access right that the user has on the capacity

CapacityUsers

The OData response wrapper for a list of Power BI users with access to a capacity

PrincipalType

The principal type

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

CapacityUser

A Power BI user access right entry for a capacity

Name Type Description
capacityUserAccessRight

The access right that the user has on the capacity

displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

graphId
  • string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier
  • string

Identifier of the principal

principalType

The principal type

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

userType
  • string

Type of the user.

capacityUserAccessRight

The access right that the user has on the capacity

Name Type Description
Admin
  • string

User has administrator rights on the capacity

Assign
  • string

User has contributor rights and can assign workspaces to the capacity

None
  • string

User doesn't have access to the capacity

CapacityUsers

The OData response wrapper for a list of Power BI users with access to a capacity

Name Type Description
odata.context
  • string
value

The list of users with access to a capacity

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

No principal type. Use for whole organization level access.

User
  • string

User principal type

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Name Type Description
displayName
  • string

The service principal profile name

id
  • string

The service principal profile ID