topic Re: Unable to add groups to a workspace using Rest API in Developer

Unable to add groups to a workspace using Rest API

Anonymous — Fri, 14 Oct 2022 19:17:22 GMT

l need to use powershell to add a group to an existing workspace

Invoke-RestMethod -Method POST -Uri "https://api.powerbi.com/v1.0/myorg/groups/<groupId>/users" -Header @{Authorization = 'Bearer $token'; 'Content-type' = 'application/json'; 'User-Agent' = 'Jenkins'} -Body '{"principalType" = "Group", "groupUserAccessRight"= "Admin", "identifier"= "ID", "displayName"="MyGroupName"}'

I keep getting (400) Bad Request error. I am able to add individual users with this body:

{"groupUserAccessRight"= "Admin", "emailAddress"= "john@microsoft.com"}

What am I doing wrong to add groups?

EDIT: The problem seem to be the identifier number I am using. I am not sure how to retrieve the proper one though

Re: Unable to add groups to a workspace using Rest API

lbendlin — Sun, 16 Oct 2022 19:59:20 GMT

The groups need to be mail enabled AD groups. The ID is the AD GUID of the group.

Re: Unable to add groups to a workspace using Rest API

v-jianboli-msft — Wed, 19 Oct 2022 06:05:15 GMT

Hi @Anonymous ,

With PowerShell, you can add an AD group to Power BI Workspace using the Groups – Add Group User API or Add-PowerBIWorkspaceUser Cmdlet.

What you will need:

Object ID for the group
- From Azure Active Directory -> Select Groups -> Select the required Group -> Copy the Object ID
Access right to the Workspace for the group
- Level of Access you want to grant to the Workspace (
  Member, Admin, Contributor, Viewer )
The PrincipalType
- The type of Principal you want to add (
  App, Group, User ) For this example, we want to add an AD Security Group, so we will use Group
The Workspace ID
- From Power BI Service -> Select the Workspace -> copy the ID next to Group in the URL.

For more details, please refer to:

ADDING AZURE AD SECURITY GROUP TO POWER BI WORKSPACE USING POWERSHELL - Ruki's Blog

Power BI Group management using Active Directory roles and PowerShell

Best Regards,

Jianbo Li

If this post helps, then please consider Accept it as the solution to help the other members find it more quickly.