Admin - Profiles GetProfilesAsAdmin

Retorna uma lista de perfis de entidade de serviço para a organização.

Permissões

O usuário deve ter direitos de administrador ou autenticar usando uma entidade de serviço.

Escopo necessário

Tenant.Read.All ou Tenant.ReadWrite.All

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
$filter
query

string

Filtra os resultados com base em uma condição booliana, usando 'id', 'displayName' ou 'servicePrincipalId'. Dá suporte apenas ao operador 'eq'.

$skip
query

integer

int32

Ignora os primeiros n resultados. Use com superior para buscar resultados além dos primeiros 5000.

$top
query

integer

int32

Retorna apenas os primeiros n resultados. Esse parâmetro deve estar no intervalo de 1 a 5000.

Respostas

Nome Tipo Description
200 OK

AdminServicePrincipalProfiles

OK

Exemplos

Get a specific service principal profile by id using filter
Get service principal profiles by their parent servicePrincipalId using filter

Get a specific service principal profile by id using filter

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/profiles?$filter=id%20eq%20'3b211778-e7a5-4d73-8187-f10824047724'

Sample Response

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

Get service principal profiles by their parent servicePrincipalId using filter

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/profiles?$filter=servicePrincipalId%20eq%20'12345678-e7a5-4d73-8187-f10824041234'

Sample Response

{
  "value": [
    {
      "id": "3b211778-e7a5-4d73-8187-f10824047724",
      "displayName": "My new profile",
      "servicePrincipalId": "12345678-e7a5-4d73-8187-f10824041234"
    },
    {
      "id": "43211778-e7a5-4d73-8187-f10824044321",
      "displayName": "My new profile2",
      "servicePrincipalId": "12345678-e7a5-4d73-8187-f10824041234"
    }
  ]
}

Definições

Nome Description
AdminServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.

AdminServicePrincipalProfiles

Wrapper de resposta Odata para uma coleção de perfis principal do serviço do Power BI.

AdminServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.

Nome Tipo Description
displayName

string

O nome do perfil da entidade de serviço

id

string

A ID do perfil da entidade de serviço

servicePrincipalId

string

A ID da entidade de serviço

AdminServicePrincipalProfiles

Wrapper de resposta Odata para uma coleção de perfis principal do serviço do Power BI.

Nome Tipo Description
odata.context

string

Contexto OData

value

AdminServicePrincipalProfile[]

A coleção de perfis da entidade de serviço