Reply
kimlaurits
Frequent Visitor

Add-PowerBIWorkspaceUser - adding group to Workspace

Hi,

I am trying to automate different PowerBI tasks using a service principal.

I can create new PowerBI Workspaces and the service principal is an admin on the Workspace.

Afterwards I would like to add a synchronised AD group as contributor, with the following:
Add-PowerBIWorkspaceUser -Id <ID of PowerBI Workspace> -PrincipalType Group -AccessRight Contributor -Identifier <Object Id of AD group>

I get the error:

Add-PowerBIWorkspaceUser : Operation returned an invalid status code 'NotFound'

 

Am I missing something - or doing it wrong?

 

 

 

1 ACCEPTED SOLUTION
avatar user
Anonymous
Not applicable

HI , 
Below worked like a charm : 

mahakrathore_0-1654173532730.png

 

Add-PowerBIWorkspaceUser -Scope Organization -Id <workspaceid> -UserEmailAddress mahak@xxxxxxxxx.com -AccessRight Admin
Ensure: You have Admin Rights to add the user. I tested it just now my user from which running API has Admin Rights on the workspace and its Premium ( to be considered if you are adding free user ) 

Waiting for update 🙂 

CHeers
Mahak


 

View solution in original post

10 REPLIES 10
avatar user
Anonymous
Not applicable

Did you tried : 

Add-PowerBIWorkspaceUser -Scope Individual -Id myWorkSpaceIDasString -Identifier myIdentifierAsString -AccessRight Admin -PrincipalType Group

Regards,Mahak 

avatar user
Anonymous
Not applicable

Also, there is a very nice blog/code available for Automation: https://github.com/microsoft/powerbi-powershell/blob/master/src/Modules/Workspaces/Commands.Workspac... which can help more. Tried and Tested.

I tried it, but I get the same error:

Add-PowerBIWorkspaceUser : Operation returned an invalid status code 'NotFound'

 

It works when I add a user to a Workspace:

Add-PowerBIWorkspaceUser -Id <Workspace Id> -AccessRight Contributor -Identifier <User UPN> -PrincipalType User

avatar user
Anonymous
Not applicable

HI , 
Below worked like a charm : 

mahakrathore_0-1654173532730.png

 

Add-PowerBIWorkspaceUser -Scope Organization -Id <workspaceid> -UserEmailAddress mahak@xxxxxxxxx.com -AccessRight Admin
Ensure: You have Admin Rights to add the user. I tested it just now my user from which running API has Admin Rights on the workspace and its Premium ( to be considered if you are adding free user ) 

Waiting for update 🙂 

CHeers
Mahak


 

Yes - the same works here, when adding a user.

 

But unfortunately it doesn't work when adding a AD group.

avatar user
Anonymous
Not applicable

Did you tried the latest code I posted?

avatar user
Anonymous
Not applicable

Login-PowerBI

#Using AD Security group

$Body = @{
identifier= “add your Odject ID here” #Object ID for the Security group
groupUserAccessRight= “Admin” #Permission for the group to the Workspace
principalType= “Group” #The type of Principal(App, Group, User)
}

$BodyJSON=$Body | ConvertTo-Json
Invoke-PowerBIRestMethod -Method post -Url “/groups/Add your group Id here/users” -Body $BodyJSON #Workspace ID

 

Can you trythis too. 

 

This worked for me to add my Functional Email Group to the same workspace.


Cheers 
Mahak

avatar user
Anonymous
Not applicable

@kimlaurits 

mahakrathore_0-1654174373605.png

#Using AD Security group

$Body = @{
identifier= “<groupidfromAzureAD>” #Object ID for the Security group
groupUserAccessRight= “Admin” #Permission for the group to the Workspace
principalType= “Group” #The type of Principal(App, Group, User)
}

$BodyJSON=$Body | ConvertTo-Json
Invoke-PowerBIRestMethod -Method post -Url “/groups/<workspaceIDpastehere>/users” -Body $BodyJSON #Workspace ID


Cheers
Mahak

 

Yes, that seems to work well.

 

avatar user
Anonymous
Not applicable

Awesome. Could you please mark it as Solution Provided i.e. my answer. 

Cheers

Mahak

avatar user

Helpful resources

Announcements
Las Vegas 2025

Join us at the Microsoft Fabric Community Conference

March 31 - April 2, 2025, in Las Vegas, Nevada. Use code MSCUST for a $150 discount!

ArunFabCon

Microsoft Fabric Community Conference 2025

Arun Ulag shares exciting details about the Microsoft Fabric Conference 2025, which will be held in Las Vegas, NV.

December 2024

A Year in Review - December 2024

Find out what content was popular in the Fabric community during 2024.

Top Solution Authors (Last Month)
Top Kudoed Authors (Last Month)