Groups - Add Group User

Servicio:

Power BI REST APIs

Versión de la API:

v1.0

Concede al usuario especificado los permisos especificados al área de trabajo especificada.

Permisos

Un perfil de entidad de servicio puede llamar a esta llamada API. Para obtener más información, consulte: perfiles de entidad de servicio de en Power BI Embedded.

Ámbito requerido

Workspace.ReadWrite.All

Limitaciones

• Los permisos de usuario para las áreas de trabajo tardan tiempo en actualizarse y es posible que no estén disponibles inmediatamente al usar llamadas API. Para actualizar los permisos de usuario, use la llamada API de Actualizar permisos de usuario.
  
  

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
groupId	path	True	string (uuid)	Identificador del área de trabajo

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
groupUserAccessRight	True	GroupUserAccessRight	Derecho de acceso (nivel de permiso) que un usuario tiene en el área de trabajo
identifier	True	string	Identificador de la entidad de seguridad
principalType	True	PrincipalType	El tipo de entidad de seguridad
displayName		string	Nombre para mostrar de la entidad de seguridad
emailAddress		string	Dirección de correo electrónico del usuario
graphId		string	Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administración.
profile		ServicePrincipalProfile	Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded.
userType		string	Tipo del usuario.

Respuestas

Nombre	Tipo	Description
200 OK		De acuerdo

Ejemplos

Assign administrator user access rights to a service principal example

Example

Assign administrator user access rights to a service principal example

Solicitud de ejemplo

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

Cuerpo de la solicitud

{
  "identifier": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
  "groupUserAccessRight": "Admin",
  "principalType": "App"
}

Respuesta de muestra

status code:

200

Example

Solicitud de ejemplo

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

Cuerpo de la solicitud

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

Respuesta de muestra

status code:

200

Definiciones

Nombre	Description
GroupUser	Un usuario de Power BI con acceso al área de trabajo
GroupUserAccessRight	Derecho de acceso (nivel de permiso) que un usuario tiene en el área de trabajo
PrincipalType	El tipo de entidad de seguridad
ServicePrincipalProfile	Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded.

GroupUser

Object

Un usuario de Power BI con acceso al área de trabajo

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad
emailAddress	string	Dirección de correo electrónico del usuario
graphId	string	Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administración.
groupUserAccessRight	GroupUserAccessRight	Derecho de acceso (nivel de permiso) que un usuario tiene en el área de trabajo
identifier	string	Identificador de la entidad de seguridad
principalType	PrincipalType	El tipo de entidad de seguridad
profile	ServicePrincipalProfile	Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded.
userType	string	Tipo del usuario.

GroupUserAccessRight

Enumeración

Derecho de acceso (nivel de permiso) que un usuario tiene en el área de trabajo

Valor	Description
Admin	Derechos de administrador para el contenido del área de trabajo
Contributor	Acceso de lectura y exploración (ReadExplore) al contenido del área de trabajo
Member	Leer, volver a compartir y explorar (ReadReshareExplore) derechos de acceso al contenido del área de trabajo
None	Sin acceso al contenido del área de trabajo
Viewer	Acceso de solo lectura (lectura) al contenido del área de trabajo

PrincipalType

Enumeración

El tipo de entidad de seguridad

Valor	Description
App	Tipo de entidad de servicio
Group	Tipo de entidad de seguridad de grupo
None	No hay ningún tipo de entidad de seguridad. Se usa para el acceso de nivel de organización completo.
User	Tipo de entidad de seguridad de usuario

ServicePrincipalProfile

Object

Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded.

Nombre	Tipo	Description
displayName	string	El nombre del perfil de entidad de servicio
id	string (uuid)	Identificador del perfil de la entidad de servicio