Items - List Item Access Details

Referência

Serviço:: Admin

Versão da API:: v1

Nota

Essa API está em versão prévia.

Retorna uma lista de usuários (incluindo grupos e entidades de serviço) e lista suas funções de workspace.

Permissões

O chamador deve ser um administrador do Fabric ou autenticar usando uma entidade de serviço.

Escopos delegados necessários

Tenant.Read.All ou Tenant.ReadWrite.All

Limitações

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

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Sim
entidade de serviço e identidades gerenciadas	Sim

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}/users

Com parâmetros opcionais:

GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}/users?type={type}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
itemId	path	True	string uuid	A ID do item.
workspaceId	path	True	string uuid	A ID do workspace.
type	query		string	O tipo do item. Ao consultar os seguintes tipos, esse parâmetro é necessário: Relatório Painel SemanticModel Aplicação Fluxo

Nome

Obrigatório

Tipo

Description

itemId

path

True

string

uuid

A ID do item.

workspaceId

path

True

string

uuid

A ID do workspace.

type

query

string

O tipo do item. Ao consultar os seguintes tipos, esse parâmetro é necessário:

Relatório
Painel
SemanticModel
Aplicação
Fluxo

Respostas

Nome	Tipo	Description
200 OK	ItemAccessDetailsResponse	A operação foi bem-sucedida.
Other Status Codes	ErrorResponse	Códigos de erro comuns: ItemNotFound – A ID do item não existe. InvalidItemType – O tipo de item não é válido.

Nome

Tipo

Description

200 OK

ItemAccessDetailsResponse

A operação foi bem-sucedida.

Other Status Codes

ErrorResponse

Códigos de erro comuns:

ItemNotFound – A ID do item não existe.
InvalidItemType – O tipo de item não é válido.

Exemplos

List of users for given item ID and type example

List of users for given item ID example

List of users for given item ID and type example

Solicitação de exemplo

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48/users?type=Report

Resposta de exemplo

Código de status:: 200

{
  "accessDetails": [
    {
      "principal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      },
      "itemAccessDetails": {
        "type": "Report",
        "permissions": [
          "Read",
          "Reshare"
        ],
        "additionalPermissions": [
          "ReadAll"
        ]
      }
    }
  ]
}

List of users for given item ID example

Solicitação de exemplo

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48/users

Resposta de exemplo

Código de status:: 200

{
  "accessDetails": [
    {
      "principal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      },
      "itemAccessDetails": {
        "type": "Notebook",
        "permissions": [
          "Read",
          "Reshare"
        ],
        "additionalPermissions": [
          "ReadAll",
          "viewOutput"
        ]
      }
    },
    {
      "principal": {
        "id": "c7db8e03-c8cb-4d4c-9f64-1dcd327c9d3c",
        "displayName": "Eric Solomon",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "eric@example.com"
        }
      },
      "itemAccessDetails": {
        "type": "Notebook",
        "permissions": [
          "Read",
          "Reshare",
          "Explore"
        ],
        "additionalPermissions": [
          "ReadAll"
        ]
      }
    },
    {
      "principal": {
        "id": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
        "displayName": "TestSecurityGroup",
        "type": "Group",
        "groupDetails": {
          "groupType": "SecurityGroup"
        }
      },
      "itemAccessDetails": {
        "type": "Notebook",
        "permissions": [
          "Read",
          "Reshare"
        ],
        "additionalPermissions": []
      }
    }
  ]
}

Definições

Nome	Description
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
GroupDetails	Detalhes específicos do grupo. Aplicável quando o tipo principal é `Group`.
GroupType	O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.
ItemAccessDetail	Detalhes da permissão do item, como de leitura e compartilhar novamente.
ItemAccessDetails	Detalhes de acesso do usuário para um item.
ItemAccessDetailsResponse	Uma lista de usuários com acesso a uma determinada entidade.
ItemPermissions	Permissões de item. Permissões de item adicionais podem ser adicionadas ao longo do tempo.
ItemType	O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
Principal	Representa uma identidade ou um grupo do Microsoft Entra.
PrincipalType	O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.
ServicePrincipalDetails	Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipal`.
ServicePrincipalProfileDetails	Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipalProfile`.
UserDetails	Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é `User`.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

GroupDetails

Objeto

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.

Nome	Tipo	Description
groupType	GroupType	O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

GroupType

Enumeração

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

Valor	Description
DistributionList	Principal é uma lista de distribuição.
SecurityGroup	A entidade de segurança é um grupo de segurança.
Unknown	O tipo de grupo principal é desconhecido.

ItemAccessDetail

Objeto

Detalhes da permissão do item, como de leitura e compartilhar novamente.

Nome	Tipo	Description
additionalPermissions	string[]	Permissões de carga de trabalho, como readAll e viewOutput.
permissions	ItemPermissions[]	Permissões de item, como de leitura e recompartilhar.
type	ItemType	Tipo de entidade.

ItemAccessDetails

Objeto

Detalhes de acesso do usuário para um item.

Nome	Tipo	Description
itemAccessDetails	ItemAccessDetail	Permissões de item para o usuário.
principal	Principal	Informações sobre o usuário que tem acesso à entidade.

ItemAccessDetailsResponse

Objeto

Uma lista de usuários com acesso a uma determinada entidade.

Nome	Tipo	Description
accessDetails	ItemAccessDetails[]	Uma lista de usuários com acesso a uma entidade.

ItemPermissions

Enumeração

Permissões de item. Permissões de item adicionais podem ser adicionadas ao longo do tempo.

Valor	Description
Execute	O usuário pode executar e cancelar trabalhos de item.
Explore	O usuário pode criar itens em outros itens.
Read	O usuário pode ler os metadados sobre um item.
Reshare	O usuário pode compartilhar um item com outros usuários.
Write	O usuário pode executar operações de gravação em um item.

ItemType

Enumeração

O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Dashboard	Painel do PowerBI.
DataPipeline	Um pipeline de dados.
Datamart	Datamart do PowerBI.
Environment	Um ambiente.
Eventhouse	Uma casa de eventos.
Eventstream	Um fluxo de eventos.
GraphQLApi	Um item de API para GraphQL.
KQLDashboard	Um painel KQL.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
Lakehouse	Uma casa no lago.
MLExperiment	Um experimento de aprendizado de máquina.
MLModel	Um modelo de machine learning.
MirroredDatabase	Um banco de dados espelhado.
MirroredWarehouse	Um armazém espelhado.
MountedDataFactory	Um MountedDataFactory.
Notebook	Um bloco de anotações.
PaginatedReport	Relatório paginado do PowerBI.
Reflex	Um Reflexo.
Report	Relatório do PowerBI.
SQLDatabase	Um SQLDatabase.
SQLEndpoint	Um ponto de extremidade SQL.
SemanticModel	Modelo semântico do PowerBI.
SparkJobDefinition	Uma definição de trabalho do Spark.
Warehouse	Um armazém.

Principal

Objeto

Representa uma identidade ou um grupo do Microsoft Entra.

Nome	Tipo	Description
displayName	string	O nome de exibição da entidade de segurança.
groupDetails	GroupDetails	Detalhes específicos do grupo. Aplicável quando o tipo principal é `Group`.
id	string uuid	A ID da entidade de segurança.
servicePrincipalDetails	ServicePrincipalDetails	Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipalProfile`.
type	PrincipalType	O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.
userDetails	UserDetails	Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é `User`.

PrincipalType

Enumeração

O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Group	A entidade de segurança é um grupo de segurança.
ServicePrincipal	A entidade de segurança é uma entidade de serviço do Microsoft Entra.
ServicePrincipalProfile	Principal é um perfil de entidade de serviço.
User	Principal é uma entidade de usuário do Microsoft Entra.

ServicePrincipalDetails

Objeto

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.

Nome	Tipo	Description
aadAppId	string uuid	O Microsoft Entra AppId da entidade de serviço.

ServicePrincipalProfileDetails

Objeto

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.

Nome	Tipo	Description
parentPrincipal	Principal	A entidade pai do perfil da entidade de serviço.

UserDetails

Objeto

Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é User.

Nome	Tipo	Description
userPrincipalName	string	O nome da entidade de usuário.

Compartilhar via

Items - List Item Access Details

Permissões

Escopos delegados necessários

Limitações

Identidades com suporte do Microsoft Entra

Interface

Parâmetros de URI

Respostas

Exemplos

List of users for given item ID and type example

Solicitação de exemplo

Resposta de exemplo

List of users for given item ID example

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemAccessDetail

ItemAccessDetails

ItemAccessDetailsResponse

ItemPermissions

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

Recursos adicionais