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
jimmcslim
Helper III
Helper III

Format of credentials for Gateways.UpdateDatasourceAsync

Updating the credentials for a datasource is generally done using these sorts of JSON passed to UpdateDatasourceAsync...

 

{

  "credentials":"{\"credentialData\":[{\"name\":\"key\",\"value\":\"hi...rg==\"}]}",

  "credentialType": "Key",

  "encryptedConnection": "Encrypted | NotEncrypted", // chose one

  "privacyLevel": "None | Private | Organizational | Public"// chose one

  "encryptionAlgorithm":"None"

}

 

* Is this documented anywhere? e.g. what should the format for 'credentials' be for other types of datasources? I feel that we shouldn't have to come to this forum for this sort of information.

* Rather than crafting a JSON string, it would be good if the PowerBI Client SDK supported a strongly-typed class for each datasource type.

* EncryptedConnection/PrivacyLevel/EncryptedAlgorithm: is there any documentation around these at all? When should they be used? What types of datasource do they apply to?

* Datasource Name: The datasource object that is returned by various APIs has a 'DatasourceName' property - this is invariably blank. It would be handy to have this populated in the event that a report had multiple datasources of the same type - it is possible to distinguish between them via the ConnectionDetails property, however that is a bit tricky. I'm assuming that this relies on Power BI Desktop supporting datasource names that it currently doesn't.

1 REPLY 1
v-ljerr-msft
Microsoft Employee
Microsoft Employee

Hi @jimmcslim,

 

After a few research, I haven't found any useful documentation to better understand the format of credentials for Gateways.UpdateDatasourceAsync.

 

It seems to be that the documentation for Power BI Embedded libraries for .NET isn't helpful enough currently. So I would suggest you leave a comments here(bottom of the page) to give your feedback and improve the documentation. Smiley Happy

 

Regards

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 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.