Power BI OAuth2 Account

Power BI OAuth2 Account

In this article

Overview

Use this account type to connect PowerBI Snaps with data sources that use OAuth2 accounts.

Prerequisites

  • Valid Azure application with all the required API permissions.

  • Valid client ID and client secret.

Refer to the table for the required scopes: 

Operation

Scope

Operation

Scope

Add Dashboard

Content.Create

Clone Tile

Dashboard.ReadWrite.All

Get Dashboard

Dashboard.ReadWrite.All or Dashboard.Read.All

Get Tiles

Dashboard.ReadWrite.All or Dashboard.Read.All

Get Dataset

Dataset.ReadWrite.All or Dataset.Read.All

Get Datasources

Dataset.ReadWrite.All or Dataset.Read.All

Get Direct Query Refresh Schedule

Dataset.ReadWrite.All or Dataset.Read.All

Get Gateway Datasources

Dataset.ReadWrite.All or Dataset.Read.All

Get Parameters

Dataset.ReadWrite.All

Get Refresh History

Dataset.ReadWrite.All or Dataset.Read.All

Get Refresh Schedule

Dataset.ReadWrite.All or Dataset.Read.All

Update Datasources

Dataset.ReadWrite.All

Update Direct Query Refresh Schedule

Dataset.ReadWrite.All

Update Parameters

Dataset.ReadWrite.All

Update Refresh Schedule

Dataset.ReadWrite.All

Bind To Gateway

Dataset.ReadWrite.All

Delete Dataset

Dataset.ReadWrite.All

Get Datasource

Dataset.ReadWrite.All or Dataset.Read.All

Get Datasource Status

Dataset.ReadWrite.All

Get Datasource Users

Dataset.ReadWrite.All or Dataset.Read.All

Get Gateway

Dataset.ReadWrite.All or Dataset.Read.All

Update Datasource

Dataset.ReadWrite.All

Add Datasource User

Dataset.ReadWrite.All

Get Groups

Workspace.Read.All or Workspace.ReadWrite.All

Get Import

Dataset.ReadWrite.All or Dataset.Read.All

Post Import

Dataset.ReadWrite.All

PostDataset

Dataset.ReadWrite.All

Datasets PostRows

Dataset.ReadWrite.All

Datasets PutTable

Dataset.ReadWrite.All

Reports - Get Datasources

Report.ReadWrite.All or Report.Read.All

Get Report

Report.ReadWrite.All or Report.Read.All

Reports - Update Datasources

Reports.ReadWrite.All

Update Report Content

Report.ReadWrite.All

Clone Report

Content.Create

Delete Report

Report.ReadWrite.All

Limitations

None.

Known Issues

None.

Account Settings

Parameter

Data Type

Description

Default Value

Example 

Parameter

Data Type

Description

Default Value

Example 

Label

String

Required. Provide a name for the account. We recommend that you update the account name if there is more than one account of the same account type in your project.

Power BI OAuth2 Account

Employee Account

Client ID

String

Required. Enter the client ID associated with your application in the Azure portal. You can create the client ID as advised by your application provider.

N/A

ab123456-c78d-9012-3456-7890ef12g345

Client secret

String

Required. Enter the client secret associated with your application in the Azure portal. You can create the client secret as advised by your application provider.

N/A

myclientsecret1234

Access token

String

Auto-generated after authorization. The token that SnapLogic uses to make API requests on behalf of the user associated with the client ID.

N/A

N/A

Refresh token

String

Auto-generated after authorization. The refresh token associated with your account. If the refresh token is stored, then the access token can be refreshed automatically before it expires.

N/A

N/A

Access token expiration

Integer

Auto-generated after authorization. The access token expiration value, in seconds.

N/A

1606999804

Header authenticated

Check box

Select this check box to indicate that the endpoint uses bearer header authentication.

Not selected

Selected

OAuth2 Endpoint

URL

Required. Enter the URL of the endpoint that authorizes the application. 

N/A

https://login.microsoftonline.com/yourcompany.onmicrosoft.com/oauth2/authorize

OAuth2 Token

String

Required. Enter the URL of the endpoint that retrieves the token for an authenticated account.

N/A

https://login.microsoftonline.com/yourcompany.onmicrosoft.com/oauth2/token

Token endpoint config

Use this fieldset to provide custom properties for the OAuth2 token endpoint. Click the + or - icons to respectively add or remove configuration rows.

This fieldset comprises the following fields:

  • Token endpoint parameter

  • Token endpoint parameter value

Token endpoint parameter

String

Required. Enter the token endpoint parameter.

N/A

response-type

Token endpoint value

String

RequiredEnter the value associated with the endpoint parameter defined above.

N/A

code

Auth endpoint config

Use this fieldset to provide custom properties for the OAuth2 auth endpoint. Click the + or - icons to respectively add or remove configuration rows.

This fieldset comprises the following fields:

  • Auth endpoint parameter

  • Auth endpoint value

Auth endpoint parameter

String

Required. Enter the authorization endpoint parameter.

N/A

scope

Auth endpoint value

String

Required. Enter the value associated with the authorization endpoint parameter defined above.

N/A

offline_access app.Read.All

Auto-refresh token

Check box

Select this check box to refresh the access token automatically using the refresh token. Otherwise, the access token expires and is not refreshed automatically.

Not selected

Selected

Authorize

Button

Click this button to authorize the account using the credentials provided in the Client ID, Client Secret, OAuth2 Endpoint, and OAuth2 Token fields. We recommend that you click this button if this is the first time you are creating this account. 

N/A

N/A

Refresh

Button

Click this button to manually refresh the account.

N/A

N/A

Troubleshooting

Error

Reason

Resolution

Error

Reason

Resolution

General communication error

The Pipeline aborted because of connection issues.

Check the network and account settings.

One or more required field is blank

You click Authorize in the account dialog window, but one or more of the following fields is blank:

  • Label

  • Client ID

  • Client Secret

  • OAuth2 Endpoint

  • OAuth2 Token

Insert valid details into the following fields and click Authorize.

  • Label

  • Client ID

  • Client Secret

  • OAuth2 Endpoint

  • OAuth2 Token

You attempted to authorize your account, but authorization failed. Thus, the following fields are empty:

  • Access token

  • Refresh token

  • Access expiration token

You still click Apply.

 


See Also