Profiles - Get Profiles

Service:

Power BI REST APIs

API Version:

v1.0

Returns a list of service principal profiles.

Returns a list of profiles that belongs to service principal caller.

Limitations

Can only be called by a service principal.

GET https://api.powerbi.com/v1.0/myorg/profiles

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/profiles?$top={$top}&$skip={$skip}&$filter={$filter}

URI Parameters

Name	In	Required	Type	Description
$filter	query		string	Get a profile by DisplayName
$skip	query		integer int32	Skips the first n results
$top	query		integer int32	Returns only the first n results

Responses

Name	Type	Description
200 OK	ServicePrincipalProfiles	OK

Examples

Get a specific profile by displayName using filter

Get service principal profiles

Get a specific profile by displayName using filter

Sample Request

GET https://api.powerbi.com/v1.0/myorg/profiles?$filter=displayName%20eq%20'My%20new%20profile'

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "3b211778-e7a5-4d73-8187-f10824047724",
      "displayName": "My new profile"
    }
  ]
}

Get service principal profiles

Sample Request

GET https://api.powerbi.com/v1.0/myorg/profiles

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "3b211778-e7a5-4d73-8187-f10824047724",
      "displayName": "My new profile"
    }
  ]
}

Definitions

Name	Description
ServicePrincipalProfile	A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.
ServicePrincipalProfiles	Odata response wrapper for a Power BI service principal profile collection.

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

ServicePrincipalProfiles

Odata response wrapper for a Power BI service principal profile collection.

Name	Type	Description
odata.context	string	OData context
value	ServicePrincipalProfile[]	The service principal profile collection