Gateways

  • Reference
Service:
Power BI REST APIs
API Version:
v1.0

Operations

Add Datasource User

Grants or updates the permissions required to use the specified datasource for the specified user.

Note: This API requires gateway admin permissions.

Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Create Datasource

Creates a new datasource on the specified gateway.

Note: This API requires gateway admin permissions.

Required scope: Dataset.ReadWrite.All

  • To set the permissions scope, see Register an app
  • To encrypt credentials, see Encrypt credentials

    		•
    Delete Datasource

    Deletes the specified datasource from the specified gateway.

    Note: This API requires gateway admin permissions.

    Required scope: Dataset.ReadWrite.All
    To set the permissions scope, see Register an app.
    Delete Datasource User

    Removes the specified user from the specified datasource.

    Note: This API requires gateway admin permissions.

    Required scope: Dataset.ReadWrite.All
    To set the permissions scope, see Register an app.
    Get Datasource

    Returns the specified datasource from the specified gateway.

    Note: This API requires gateway admin permissions.

    Required scope: Dataset.ReadWrite.All or Dataset.Read.All
    To set the permissions scope, see Register an app.
    Get Datasources

    Returns a list of datasources from the specified gateway.

    Note: This API requires gateway admin permissions.

    Required scope: Dataset.ReadWrite.All or Dataset.Read.All
    To set the permissions scope, see Register an app.
    Get Datasource Status

    Checks the connectivity status of the specified datasource from the specified gateway.

    Note: This API requires gateway admin permissions.

    Required scope: Dataset.ReadWrite.All
    To set the permissions scope, see Register an app.
    Get Datasource Users

    Returns a list of users who have access to the specified datasource.

    Note: This API requires gateway admin permissions.

    Required scope: Dataset.ReadWrite.All or Dataset.Read.All
    To set the permissions scope, see Register an app.
    Get Gateway

    Returns the specified gateway.

    Note: This API requires gateway admin permissions.

    Required scope: Dataset.ReadWrite.All or Dataset.Read.All
    To set the permissions scope, see Register an app.
    Get Gateways

    Returns a list of gateways for which the user is an admin.

    Note: This API requires gateway admin permissions.

    Required scope: Dataset.ReadWrite.All or Dataset.Read.All
    To set the permissions scope, see Register an app.
    Update Datasource

    Updates the credentials of the specified datasource from the specified gateway.

    Note:

  • This API requires gateway admin permissions.
  • It is required to set useEndUserOAuth2Credentials to False when changing from SSO to other types, such as basic or OAuth2. See the Basic credentials example.
  • With OAuth2 token credentials, make sure the generated OAuth2 token audience was set correctly according to the datasource type.


    • Required scope: Dataset.ReadWrite.All
  • To set the permissions scope, see Register an app
  • To encrypt credentials, see Encrypt credentials

    		•