Compartilhar via


Groups - Get Group Users

Retorna uma lista de usuários que têm acesso ao workspace especificado.

Permissões

Essa chamada à API pode ser chamada por um perfil de entidade de serviço. Para obter mais informações, consulte: Perfis de entidade de serviço no Power BI Embedded.

Escopo necessário

Workspace.Read.All ou Workspace.ReadWrite.All

Limitações

  • As permissões de usuário para workspaces levam tempo para serem atualizadas e podem não estar disponíveis imediatamente ao usar chamadas à API. Para atualizar as permissões do usuário, use a chamada Atualizar Permissões de Usuário API.

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/users
GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/users?$top={$top}&$skip={$skip}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
groupId
path True

string (uuid)

A ID do workspace

$skip
query

integer (int32)

Ignora os primeiros n resultados

$top
query

integer (int32)

Retorna apenas os primeiros n resultados

Respostas

Nome Tipo Description
200 OK

GroupUsers

OKEY

Exemplos

Example

Solicitação de exemplo

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

Resposta de exemplo

{
  "value": [
    {
      "displayName": "John Nick",
      "emailAddress": "john@contoso.com",
      "groupUserAccessRight": "Admin",
      "identifier": "john@contoso.com",
      "principalType": "User"
    },
    {
      "displayName": "Adam Wood",
      "emailAddress": "Adam@contoso.com",
      "groupUserAccessRight": "Member",
      "identifier": "Adam@contoso.com",
      "principalType": "User"
    },
    {
      "displayName": "ContosoTestApp",
      "groupUserAccessRight": "Admin",
      "identifier": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "principalType": "App"
    }
  ]
}

Definições

Nome Description
GroupUser

Um usuário do Power BI com acesso ao workspace

GroupUserAccessRight

O direito de acesso (nível de permissão) que um usuário tem no workspace

GroupUsers

O wrapper de resposta OData para uma lista de usuários do Power BI com acesso a um workspace

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.

GroupUser

Um usuário do Power BI com acesso ao workspace

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.

groupUserAccessRight

GroupUserAccessRight

O direito de acesso (nível de permissão) que um usuário tem no workspace

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.

GroupUserAccessRight

O direito de acesso (nível de permissão) que um usuário tem no workspace

Valor Description
None

Sem acesso ao conteúdo do workspace

Member

Direitos de acesso de leitura, recompartilhamento e exploração (ReadReshareExplore) ao conteúdo do workspace

Admin

Direitos de administrador para o conteúdo do workspace

Contributor

Acesso de leitura e exploração (ReadExplore) ao conteúdo do workspace

Viewer

Acesso somente leitura (leitura) ao conteúdo do workspace

GroupUsers

O wrapper de resposta OData para uma lista de usuários do Power BI com acesso a um workspace

Nome Tipo Description
@odata.context

string

value

GroupUser[]

A lista de usuários com acesso a um workspace

PrincipalType

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

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