Admin - Apps GetAppUsersAsAdmin

Service:

Power BI REST APIs

API Version:

v1.0

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

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.

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.

Limitations

Maximum 200 requests per hour.

GET https://api.powerbi.com/v1.0/myorg/admin/apps/{appId}/users

URI Parameters

Name	In	Required	Type	Description
appId	path	True	string uuid	The app ID

Responses

Name	Type	Description
200 OK	AppUsers	OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/apps/f089354e-8366-4e18-aea3-4cb4a3a50b48/users

Sample Response

Status code:

200

{
  "value": [
    {
      "displayName": "John Nick",
      "emailAddress": "john@contoso.com",
      "appUserAccessRight": "ReadExplore",
      "identifier": "john@contoso.com",
      "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
      "principalType": "User"
    }
  ]
}

Definitions

Name	Description
AppUser	A Power BI user access right entry for an app
AppUserAccessRight	The access right that the user has for the app
AppUsers	The OData response wrapper for a list of Power BI users with access to an app
PrincipalType	The principal type

AppUser

A Power BI user access right entry for an app

Name	Type	Description
appUserAccessRight	AppUserAccessRight	The access right that the user has for the app
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	PrincipalType	The principal type

AppUserAccessRight

The access right that the user has for the app

Name	Type	Description
All	string	Grants Read, Write, Explore, Reshare and Copy access to content in app
None	string	No permission to content in app
Read	string	Grants Read access to content in app
ReadCopy	string	Grants Read and Copy access to content in app
ReadExplore	string	Grants Read and Explore access to content in app
ReadExploreCopy	string	Grants Read, Explore and Copy access to content in app
ReadReshare	string	Grants Read and Reshare access to content in app
ReadReshareCopy	string	Grants Read, Reshare, and Copy access to content in app
ReadReshareExplore	string	Grants Read, Reshare and Explore access to content in app
ReadReshareExploreCopy	string	Grants Read, Reshare, Explore and Copy access to content in app
ReadWrite	string	Grants Read and Write access to content in app
ReadWriteExplore	string	Grants Read, Write and Explore access to content in app
ReadWriteExploreCopy	string	Grants Read, Write, Explore and Copy access to content in app
ReadWriteReshare	string	Grants Read, Write and Reshare access to content in app
ReadWriteReshareExplore	string	Grants Read, Write, Reshare and Explore access to content in app

AppUsers

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

Name	Type	Description
odata.context	string
value	AppUser[]	The list of users with access to an app

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