Compartilhar via

Groups - Add Group User

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

Concede ao usuário especificado as permissões especificadas para o 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.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.
  • Cada workspace é limitado a um máximo de 1.000 usuários ou grupos em funções de workspace (Administrador, Membro, Colaborador, Visualizador). O número de usuários em um grupo não é limitado. A limitação também abrange convidados externos. 

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/users

Parâmetros de URI

Nome Em Obrigatório Tipo Description
groupId
 path True

string (uuid)

A ID do workspace

Corpo da solicitação

Nome Obrigatório Tipo Description
groupUserAccessRight True

GroupUserAccessRight

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

string

Identificador da entidade de segurança
principalType True

PrincipalType

O tipo principal
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.
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.

Respostas

Nome Tipo Description
200 OK

OKEY

Exemplos

Assign administrator user access rights to a service principal example
Example

Assign administrator user access rights to a service principal example

Solicitação de exemplo

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users
Corpo da solicitação
{
  "identifier": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
  "groupUserAccessRight": "Admin",
  "principalType": "App"
}

Resposta de exemplo

Código de status:
200

Example

Solicitação de exemplo

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users
Corpo da solicitação
{
  "emailAddress": "john@contoso.com",
  "groupUserAccessRight": "Admin"
}

Resposta de exemplo

Código de status:
200

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
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

Objeto

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

Enumeração

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

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