Admin - Groups AddUserAsAdmin

Service:

Power BI REST APIs

API Version:

v1.0

Concede permissões de usuário ao workspace especificado.

Essa chamada à API só dá suporte à adição de um usuário, grupo de segurança, grupo M365 e entidade de serviço.

Permissões

O usuário deve ter direitos de administrador (como Office 365 Administrador Global ou Administrador de Serviços do Power BI).

Escopo necessário

Tenant.ReadWrite.All

Limitações

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

POST https://api.powerbi.com/v1.0/myorg/admin/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 de entidade de segurança
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 apenas para APIs de administrador.
profile		ServicePrincipalProfile	Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações.
userType		string	Tipo do usuário.

Respostas

Nome	Tipo	Description
200 OK		OK

Exemplos

Add security group to workspace example

Add service principal to workspace example

Add user to group example

Add security group to workspace example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users

Request Body

{
  "identifier": "ece007fa-2f19-4df1-bdd5-539881ec5f83",
  "principalType": "Group",
  "groupUserAccessRight": "Member"
}

Sample Response

Status code:

200

Add service principal to workspace example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users

Request Body

{
  "identifier": "84c468ad-12f1-471e-af6f-0999da422391",
  "principalType": "App",
  "groupUserAccessRight": "Viewer"
}

Sample Response

Status code:

200

Add user to group example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users

Request Body

{
  "emailAddress": "john@contoso.com",
  "groupUserAccessRight": "Admin"
}

Sample Response

Status code:

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 de entidade de segurança
ServicePrincipalProfile	Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações.

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 apenas 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 de entidade de segurança
profile	ServicePrincipalProfile	Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações.
userType	string	Tipo do usuário.

GroupUserAccessRight

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

Nome	Tipo	Description
Admin	string	Direitos de administrador para o conteúdo do workspace
Contributor	string	Acesso de leitura e exploração (ReadExplore) ao conteúdo do workspace
Member	string	Direitos de acesso de leitura, recompartilhamento e exploração (ReadReshareExplore) ao conteúdo do workspace
None	string	Sem acesso ao conteúdo do workspace
Viewer	string	Acesso somente leitura (leitura) ao conteúdo do workspace

PrincipalType

O tipo de entidade de segurança

Nome	Tipo	Description
App	string	Tipo de entidade de serviço
Group	string	Tipo de entidade de grupo
None	string	Nenhum tipo de entidade de segurança. Use para acesso em nível de organização inteiro.
User	string	Tipo de entidade de usuário

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações.

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