topic Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ? in Developer

How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

Anonymous — Mon, 24 May 2021 09:10:47 GMT

I need to get a list of all the Gateway clusters that is available in power bi portal. I went through the Rest Apis documentation(https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/getgateway) and found that this API requires gateway admin permissions. I am using a Service Principal and have the permissions scope Gateway.ReadWrite.All & DataSet.ReadWrite.All set.
From the Power Bi portal, it is not possible to add a Service Principal as a gateway admin. I tried the following steps and not able to succeed:

Tried to add a service principal as an admin to the Gateway from the UI using the service principal name and object id, but it is not allowing and throwing error:
These email addresses are invalid or duplicate: Service Principal Name
Specify at least one email address
Tried to create an AD group and added the Service Principal to that group and tried to add this group as an admin from the UI, but it is also not allowing and throwing the same error:
Specify at least one email address

On further analysis, found the powershell cmdlet DataGateway. Using this cmdlet, I am able to create a new gateway cluster with Service Principal as an admin and this gateway cluster is getting listed in the Get Gateways api.

But, I am not able to add the Service Principal as an admin to existing gateways using this powershell cmdlets also.

Is this the only possible solution to add a Service Principal as an admin to a Gateway Cluster ?
Is there any option to add Service Principal as an admin user to an existing Gateway Cluster using this powershell script ?

Do we have any API to add the Service Principal as an admin to the existing Gateway Cluster ?

Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

V-lianl-msft — Wed, 26 May 2021 02:31:24 GMT

Hi @Anonymous ,

Within the Power BI Admin portal, we need to ensure that our Tenant settings allow service principals to use Power BI APIs. In addition, you can restrict access to the APIs through security groups.

For more details,please refer to:

https://www.serverlessnotes.com/docs/list-gateways-power-bi-rest-api

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

Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

Anonymous — Fri, 11 Jun 2021 16:05:07 GMT

Thanks for the reponse. The tenant level developer settings for using SPN are already given and as I mentioned in the above description, I was able to list the gateways that are created using the Powershell cmdlet. My concern is regarding adding the SPN as an admin to the the gateways that exists already.

Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

axires — Wed, 20 Oct 2021 18:13:09 GMT

Hi @sreejiths,

I hope this topic is not stale for you.*

1- As advised in the documentation, add your Service Principal to a Security Group

2- Then go to the Power Platform Admin Portal > Data section and add this Security Group to your Gateway's Admins

Your Service Principal will then have access to the gateway.

Hope this helps !

Franck

Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

chriswhite1 — Thu, 24 Mar 2022 09:15:59 GMT

did you manage to find a solution to adding a Service principal to an existing gateway on PBI?

Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

Anonymous — Sat, 21 May 2022 00:41:11 GMT

I am also having this problem, my SP is in a security group ,I have added the security group as admin on all the gateways, I have this security group allowed to use all the APIs in Power BI tenant settings.

Still, the SP call to api.powerbi.com/v1.0/myorg/gateways returns an empty list.

The SP is able to call all other API endpoints I have tried without a problem.

Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

Christophe93 — Mon, 12 Sep 2022 11:51:27 GMT

It's Impossible to add manually a AAD SP to a gateway (As admin for example)

But it can be done via Powershell

https://blog.jpries.com/2021/11/25/adding-a-non-email-enabled-object-to-power-bi-gateway-cluster-users/

Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

kpia — Tue, 24 Jan 2023 14:59:19 GMT

@Anonymous I am having the same issue. Is this something you where able to resolve?

Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

Christophe93 — Sat, 28 Jan 2023 09:38:39 GMT

Hi

On my opinion , for aleady existing on prem. gataways , ADD the Service principal as gateway Admin
<-- run via powershell only
https://blog.jpries.com/2021/11/25/adding-a-non-email-enabled-object-to-power-bi-gateway-cluster-users/

No chance for me via anothers methods ... but I get your opinions

On python call gateways inventory API via this SP connection

Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

James4336 — Thu, 09 Mar 2023 17:15:26 GMT

@kpia @Anonymous

Did you manage to find a solution to this? I am having the exact same issue, can't get Gateways as the Service Principal.

Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

Christophe93 — Thu, 09 Mar 2023 17:26:30 GMT

The unique solution : via powershell & api run

It's Impossible to add manually a AAD Service Principal to a gateway (As admin for example , to be used on python & pbi gateway apis)

But it can be done via Powershell

https://blog.jpries.com/2021/11/25/adding-a-non-email-enabled-object-to-power-bi-gateway-cluster-use...

Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

James4336 — Thu, 09 Mar 2023 17:29:53 GMT

@kpia @duncanmi

I've just made it work!! I removed the Service Principal Security Group from the Gateway and re-added it.

The only difference this time was I added it as an Admin at the first instance, my previous attempt I initially added the Security Group as a Content Creator then later switched it to Admin. Might help someone.

Re: How to add a Service Principal as a Gateway Admin inorder to get a list of gateways using API ?

jaryszek — Thu, 16 Jan 2025 06:23:00 GMT

Hi,

thanks for your asnwer. There is no way to add service principal as admin from Power Platform without using powershell:

As admin I do not have that option:

Only powershell is existing solution, docs:
Creating a service principal application using PowerShell - Power Platform | Microsoft Learn

A lot is helping also Guy in the Cube to understand all restriction from Microsoft:
https://www.youtube.com/watch?v=lfP6ygindSU&list=PLpBU4EcPajILyeFik6p9EedYoUH4kh12m&index=7

Best,
Jacek