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

The Power BI Data Visualization World Championships is back! Get ahead of the game and start preparing now! Learn more

Reply
Anonymous
Not applicable

Problem in Update Datasource Power BI REST API Call

https://learn.microsoft.com/en-us/rest/api/power-bi/gateways/update-datasource

The Power BI REST API call mentioned above is a PATCH request that is used to change/update the datasource credentials.

 

Request body is the credentialDetails, whose format is different for different credentials type.

For basic credentials with username and password, it looks like the following - 

{ "credentialDetails": { "credentialType": "Basic", "credentials": "{\"credentialData\":[{\"name\":\"username\", \"value\":\"john\"},{\"name\":\"password\", \"value\":\"*****\"}]}", "encryptedConnection": "Encrypted", "encryptionAlgorithm": "None", "privacyLevel": "None", "useEndUserOAuth2Credentials": "False" } }

 

For on-premise encrypted credentials - 

{ "credentialDetails": { "credentialType": "Windows", "credentials": "AB....EF==", "encryptedConnection": "Encrypted", "encryptionAlgorithm": "RSA-OAEP", "privacyLevel": "None" } }

 

The problem I am facing is that the credentials I want to update is On-premise with "Windows" credential type with username and password. But I am not able to find the right json format for such a request. If anyone can help, please.

 

power BI rest API with python  Power BI REST API Update datasource credentials 

1 ACCEPTED SOLUTION
Anonymous
Not applicable

I found the answer. For using WIndows credentials, first the credentials need to be encrypted to a credential string.

The python example is given here - https://github.com/microsoft/PowerBI-Developer-Samples/tree/master/Python/Encrypt%20credentials

 

View solution in original post

5 REPLIES 5
Anonymous
Not applicable

I found the answer. For using WIndows credentials, first the credentials need to be encrypted to a credential string.

The python example is given here - https://github.com/microsoft/PowerBI-Developer-Samples/tree/master/Python/Encrypt%20credentials

 

Anonymous
Not applicable

Hey @Anonymous did you try to use the following format?

 

 "credentials": "{\"credentialData\":[{\"name\":\"username\", \"value\":\"john\"},{\"name\":\"password\", \"value\":\"*****\"}]}"

 

Let me know if this works:)  

Anonymous
Not applicable

@Anonymous 

I tried your format. It is not working. Gave an PrimitiveValue error. Then I tried the same format within curly brackets and I get the following error.

{
  "error": {
    "code": "BadRequest",
    "message": "Bad Request",
    "details": [
      {
        "message": "The property 'credentials' does not exist on type 'Microsoft.PowerBI.ServiceContracts.Api.GatewayDatasource'. Make sure to only use property names that are defined by the type.",
        "target": "datasourceDelta"
      }
    ]
  }
}

 

 

Anonymous
Not applicable

I see. This means that with "credentialtype" Windows we are not allow to use the format above. Did you try with Basic Credentials? https://learn.microsoft.com/en-us/rest/api/power-bi/gateways/update-datasource#basic-credentials-exa...

Anonymous
Not applicable

@Anonymous  Yes I did. I tried various combinations too, it didn't work. But I learnt that we have to encrypt the Windows Username and password into a single string and use that as credential. So I am now trying to find the way to do that encryption in Python. (I made a new question)

Helpful resources

Announcements
Power BI DataViz World Championships

Power BI Dataviz World Championships

The Power BI Data Visualization World Championships is back! Get ahead of the game and start preparing now!

December 2025 Power BI Update Carousel

Power BI Monthly Update - December 2025

Check out the December 2025 Power BI Holiday Recap!

FabCon Atlanta 2026 carousel

FabCon Atlanta 2026

Join us at FabCon Atlanta, March 16-20, for the ultimate Fabric, Power BI, AI and SQL community-led event. Save $200 with code FABCOMM.