Admin - 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.

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

OK

Examples

example

Sample Request

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

Sample Response

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

Definitions

AppUser

A Power BI user access right entry for app

AppUserAccessRight

Access rights user has for the app

AppUsers

Odata response wrapper for a Power BI user access right for app List

PrincipalType

The principal type

AppUser

A Power BI user access right entry for app

Name Type Description
appUserAccessRight

Access rights 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

The principal type

AppUserAccessRight

Access rights 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

Odata response wrapper for a Power BI user access right for app List

Name Type Description
odata.context
  • string
value

The user access right for app List

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

None principal type, used for whole organization level access.

User
  • string

User principal type