Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

...

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.

...

OperationScope
Add DashboardContent.Create
Clone TileDashboard.ReadWrite.All
Get DashboardDashboard.ReadWrite.All or Dashboard.Read.All
Get TilesDashboard.ReadWrite.All or Dashboard.Read.All
Get DatasetDataset.ReadWrite.All or Dataset.Read.All
Get DatasourcesDataset.ReadWrite.All or Dataset.Read.All
Get Direct Query Refresh ScheduleDataset.ReadWrite.All or Dataset.Read.All
Get Gateway DatasourcesDataset.ReadWrite.All or Dataset.Read.All
Get ParametersDataset.ReadWrite.All
Get Refresh HistoryDataset.ReadWrite.All or Dataset.Read.All
Get Refresh ScheduleDataset.ReadWrite.All or Dataset.Read.All
Update DatasourcesDataset.ReadWrite.All
Update Direct Query Refresh ScheduleDataset.ReadWrite.All
Update ParametersDataset.ReadWrite.All
Update Refresh ScheduleDataset.ReadWrite.All
Bind To GatewayDataset.ReadWrite.All
Delete DatasetDataset.ReadWrite.All
Get DatasourceDataset.ReadWrite.All or Dataset.Read.All
Get Datasource StatusDataset.ReadWrite.All
Get Datasource UsersDataset.ReadWrite.All or Dataset.Read.All
Get GatewayDataset.ReadWrite.All or Dataset.Read.All
Update DatasourceDataset.ReadWrite.All
Add Datasource UserDataset.ReadWrite.All
Get GroupsWorkspace.Read.All or Workspace.ReadWrite.All
Get ImportDataset.ReadWrite.All or Dataset.Read.All
Post ImportDataset.ReadWrite.All
PostDatasetDataset.ReadWrite.All
Datasets PostRowsDataset.ReadWrite.All
Datasets PutTableDataset.ReadWrite.All
Reports - Get DatasourcesReport.ReadWrite.All or Report.Read.All
Get ReportReport.ReadWrite.All or Report.Read.All
Reports - Update DatasourcesReports.ReadWrite.All
Update Report ContentReport.ReadWrite.All
Clone ReportContent.Create
Delete ReportReport.ReadWrite.All

Limitations

None.

Known Issues

...

ParameterData TypeDescriptionDefault ValueExample 
LabelString

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 AccountEmployee Account
Client IDString

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/Aab123456-c78d-9012-3456-7890ef12g345
Client secretStringRequired. 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/Amyclientsecret1234
Access tokenStringAuto-generated after authorization. The token that SnapLogic uses to make API requests on behalf of the user associated with the client ID.N/AN/A
Refresh tokenStringAuto-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/AN/A
Access token expirationIntegerAuto-generated after authorization. The access token expiration value, in seconds.N/A1606999804
Header authenticatedCheck boxSelect this check box to indicate that the endpoint uses bearer header authentication.Not selectedSelected
OAuth2 EndpointURLRequired. Enter the URL of the endpoint that authorizes the application. N/Ahttps://login.microsoftonline.com/yourcompany.onmicrosoft.com/oauth2/authorize
OAuth2 TokenStringRequired. Enter the URL of the endpoint that retrieves the token for an authenticated account.N/Ahttps://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 parameterStringRequired. Enter the token endpoint parameter.N/Aresponse-type
Token endpoint valueStringRequiredEnter the value associated with the endpoint parameter defined above.N/Acode
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 parameterStringRequired. Enter the authorization endpoint parameter.N/Ascope
Auth endpoint valueStringRequired. Enter the value associated with the authorization endpoint parameter defined above.N/Aoffline_access app.Read.All
Auto-refresh tokenCheck boxSelect this check box to refresh the access token automatically using the refresh token. Otherwise, the access token expires and is not refreshed automatically.Not selectedSelected
AuthorizeButtonClick 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/AN/A
RefreshButtonClick this button to manually refresh the account.N/AN/A

Troubleshooting

ErrorReasonResolution
General communication errorThe 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