Partilhar via

Admin - Users GetUserArtifactAccessAsAdmin

Serviço:
Power BI REST APIs
Versão da API:
v1.0

Retorna uma lista de itens do Power BI (como relatórios ou dashboards) aos quais o usuário especificado tem acesso.

Permissões

  • O usuário deve ser um administrador do Fabric ou autenticar usando uma entidade de serviço.
  • Há suporte para permissões delegadas.

Escopo necessário

Tenant.Read.All ou Tenant.ReadWrite.All

Limitações

Máximo de 200 solicitações por hora. 

GET https://api.powerbi.com/v1.0/myorg/admin/users/{userId}/artifactAccess
Com parâmetros opcionais: 
GET https://api.powerbi.com/v1.0/myorg/admin/users/{userId}/artifactAccess?continuationToken={continuationToken}&artifactTypes={artifactTypes}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
userId
 path True

string

A ID do grafo ou o UPN (nome de entidade de usuário) do usuário
artifactTypes
 query

string

Lista separada por vírgulas de tipos de artefato.
continuationToken
 query

string

Token necessário para obter a próxima parte do conjunto de resultados

Respostas

Nome Tipo Description
200 OK

ArtifactAccessResponse

OKEY

Exemplos

Example
Example with artifactTypes
Example with Guest User
Example with UPN

Example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "artifactAccessEntities": [
    {
      "artifactId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "displayName": "test report",
      "artifactType": "Report",
      "accessRight": "ReadWrite"
    }
  ],
  "continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/users/f089354e-8366-4e18-aea3-4cb4a3a50b48/artifactAccess?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Example with artifactTypes

Solicitação de exemplo

GET https://api.powerbi.com/v1.0/myorg/admin/users/testUser@microsoft.com/artifactAccess?artifactTypes=Dataflow,Dashboard

Resposta de exemplo

Código de status:
200 
{
  "artifactAccessEntities": [
    {
      "artifactId": "09ce06d1-e81b-fea0-1c6d-8fe3dd2f8e87",
      "displayName": "Test Dataflow",
      "artifactType": "Dataflow",
      "accessRight": "ReadWrite"
    }
  ],
  "continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/users/testUser%40microsoft.com/artifactAccess?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Example with Guest User

Solicitação de exemplo

GET https://api.powerbi.com/v1.0/myorg/admin/users/testUser_microsoft.com%23EXT%23@contoso.com/artifactAccess

Resposta de exemplo

Código de status:
200 
{
  "artifactAccessEntities": [
    {
      "artifactId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "displayName": "test report",
      "artifactType": "Report",
      "accessRight": "ReadWrite"
    }
  ],
  "continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/users/testUser_microsoft.com%23EXT%23%40contoso.com/artifactAccess?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Example with UPN

Solicitação de exemplo

GET https://api.powerbi.com/v1.0/myorg/admin/users/testUser@microsoft.com/artifactAccess

Resposta de exemplo

Código de status:
200 
{
  "artifactAccessEntities": [
    {
      "artifactId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "displayName": "test report",
      "artifactType": "Report",
      "accessRight": "ReadWrite"
    }
  ],
  "continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/users/testUser%40microsoft.com/artifactAccess?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Definições

Nome Description
ArtifactAccessEntry

Uma entrada de acesso do usuário para um item do Power BI
ArtifactAccessResponse

O wrapper de resposta OData para uma lista de itens do Power BI (como relatórios ou dashboards) que um usuário pode acessar
ArtifactType

O tipo de artefato
PrincipalType

O tipo principal
ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.
User

Um usuário do Power BI

ArtifactAccessEntry

Objeto

Uma entrada de acesso do usuário para um item do Power BI

Nome Tipo Description
accessRight

string

O direito de acesso que o usuário tem para o item do Power BI
artifactId

string

A ID do item do Power BI
artifactType

ArtifactType

O tipo de item do Power BI
displayName

string

O nome de exibição do item do Power BI
shareType

string

O tipo de como o acesso é fornecido ao item do Power BI. Disponível apenas para APIs de artefatos amplamente compartilhados.
sharer

User

O usuário que compartilhou o item do Power BI. Disponível apenas para APIs de artefatos amplamente compartilhados.

ArtifactAccessResponse

Objeto

O wrapper de resposta OData para uma lista de itens do Power BI (como relatórios ou dashboards) que um usuário pode acessar

Nome Tipo Description
@odata.context

string

artifactAccessEntities

ArtifactAccessEntry[]

A lista de itens do Power BI que um usuário pode acessar
continuationToken

string

O token para a próxima parte no conjunto de resultados
continuationUri

string

O URI da próxima parte no conjunto de resultados

ArtifactType

Enumeração

O tipo de artefato

Valor Description
Report

Relatório do Power BI
PaginatedReport

Relatório Paginado do Power BI
Dashboard

Painel do Power BI
Dataset

Conjunto de dados do Power BI
Dataflow

Fluxo de dados do Power BI
PersonalGroup

Meu objeto de workspace
Group

Objeto de workspace compartilhado V1
Workspace

Objeto de workspace compartilhado
Capacity

Objeto capacity
App

Aplicativos do Power BI

PrincipalType

Enumeração

O tipo principal

Valor Description
None

Nenhum tipo de entidade de segurança. Use todo o acesso ao nível da organização.
User

Tipo de entidade de usuário
Group

Tipo de entidade de grupo
App

Tipo de entidade de serviço

ServicePrincipalProfile

Objeto

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

Nome Tipo Description
displayName

string

O nome do perfil da entidade de serviço
id

string (uuid)

A ID do perfil da entidade de serviço

User

Objeto

Um usuário do Power BI

Nome Tipo Description
displayName

string

Nome de exibição da entidade de segurança
emailAddress

string

Endereço de email do usuário
graphId

string

Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador.
identifier

string

Identificador da entidade de segurança
principalType

PrincipalType

O tipo principal
profile

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.
userType

string

Tipo do usuário.