Admin - WidelySharedArtifacts LinksSharedToWholeOrganization

Returns a list of Power BI items (such as reports or dashboards) that are shared with the whole organization through links.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

GET https://api.powerbi.com/v1.0/myorg/admin/widelySharedArtifacts/linksSharedToWholeOrganization
GET https://api.powerbi.com/v1.0/myorg/admin/widelySharedArtifacts/linksSharedToWholeOrganization?continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
continuationToken
query
  • string

Token required to get the next chunk of the result set

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/widelySharedArtifacts/linksSharedToWholeOrganization

Sample Response

{
  "artifactAccessEntities": [
    {
      "artifactId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "displayName": "test report",
      "artifactType": "Report",
      "accessRight": "ReadWrite",
      "shareType": "Link",
      "sharer": {
        "displayName": "John Nick",
        "emailAddress": "john@contoso.com",
        "identifier": "john@contoso.com",
        "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
        "principalType": "User"
      }
    }
  ],
  "continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/widelySharedArtifacts/linksSharedToWholeOrganization?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Definitions

ArtifactAccessEntry

A user access entry for a Power BI item

ArtifactAccessResponse

The OData response wrapper for a list of Power BI items (such as reports or dashboards) that a user can access

PrincipalType

The principal type

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

User

A Power BI user

ArtifactAccessEntry

A user access entry for a Power BI item

Name Type Description
accessRight
  • string

The access right that the user has for the Power BI item

artifactId
  • string

The Power BI item ID

artifactType
  • string

The type of Power BI item

displayName
  • string

The display name of the Power BI item

shareType
  • string

The type of how the access is given to the Power BI item. Only available for widely shared artifacts APIs.

sharer

The user who shared the PowerBI item. Only available for widely shared artifacts APIs.

ArtifactAccessResponse

The OData response wrapper for a list of Power BI items (such as reports or dashboards) that a user can access

Name Type Description
artifactAccessEntities

The list of Power BI items that a user can access

continuationToken
  • string

The token for the next chunk in the result set

continuationUri
  • string

The URI of the next chunk in the result set

odata.context
  • string

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

No principal type. Use for whole organization level access.

User
  • string

User principal type

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Name Type Description
displayName
  • string

The service principal profile name

id
  • string

The service principal profile ID

User

A Power BI user

Name Type Description
displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

graphId
  • string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier
  • string

Identifier of the principal

principalType

The principal type

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

userType
  • string

Type of the user.