Skip to main content
cancel
Showing results for 
Search instead for 
Did you mean: 

July 7 - July 17 | Round 2 of the Power BI Dataviz World Championships. Don't miss your chance! Learn more

Reply
Anonymous
Not applicable

Getting error while adding AD Group as a Gateway - Datasource User using API

I have created a Gateway cluster using the powershell cmdlet DataGateway and added the Service Principal as an admin of that gateway cluster. 

The Service Principal contains the Gateway.ReadWrite.All & DataSet.ReadWrite.All permission scopes.


In the Api documentation(https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/adddatasourceuser) for Add Gateway DataSource User, the request body contains the following parameters:
datasourceAccessRight
displayName
emailAddress
identifier
principalType

 

Since the Datasource is created using API, the Service Principal already exists as a Datasource User.

I am able to add a normal user also by passing the request as:
{ "emailAddress": "[email protected]", "datasourceAccessRight": "Read" }

using the API and Service Principal.

 

I tried to add an AD group by following the sample provided in the documentation for service principal:

{ "identifier": "3d9b93c6-7b6d-4801-a491-1738910904fd", "datasourceAccessRight": "ReadOverrideEffectiveIdentity" }

and made some changes to the request JSON by adding principalType as Group:

{

  "datasourceAccessRight": "Read",

  "identifier": "AD group id",

  "principalType": "Group"

}

 

But I am getting the below error:

{"error":{"code":"DMTS_PrincipalsAreInvalidError","pbi.error":{"code":"DMTS_PrincipalsAreInvalidError","parameters":{},"details":[],"exceptionCulprit":1}}}

Why is this error coming? In this documentation page, it is not mentioned about mailEnabled groups only. Also, the request json was created based on the example provided for Service Principal.

Is there any solution to add an AD group as a Gateway - Datasource User ?

2 REPLIES 2
v-lionel-msft
Community Support
Community Support

Hi @Anonymous ,

 

We can only add 'Office 365 group‘ and 'Mail-Enabled Security group' to the datasource user, so what's your group type?

 

Best regards,
Lionel Chen

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

 

Anonymous
Not applicable

Thanks for the response.
The group type is Security group. Since the sample demonstrates adding a SPN as a Datasource user, I think we should be able to add a security group as well.

Helpful resources

Announcements
FabCon and SQLCon Barcelona 2026

FabCon & SQLCon – Barcelona 2026

Join us in Barcelona for FabCon and SQLCon, the Fabric, Power BI, SQL, and AI community event. Save €200 with code FABCMTY200.

60 days of Data Days Carousel

Data Days 2026

Join Fabric Data Days 2026: 60 days of free live/on-demand sessions, challenges, study groups, and certification opportunities.

Power BI DataViz World Championships carousel

Power BI DataViz World Championships - June 2026

A new Power BI DataViz World Championship is coming this June! Don't miss out on submitting your entry.

Top Solution Authors