External Data Shares Provider - List External Data Shares

Service:: Admin

API Version:: v1

Lists the external data shares in the tenant.

This API supports pagination.

Permissions

The caller must be a Fabric administrator or authenticate using a service principal.

Required Delegated Scopes

Tenant.ReadWrite.All

Required Tenant Settings

To use this API, enable the External data sharing admin switch for the calling principal.

Limitations

Maximum 10 requests per minute.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/items/externalDataShares

With optional parameters:

GET https://api.fabric.microsoft.com/v1/admin/items/externalDataShares?continuationToken={continuationToken}

URI Parameters

Name	In	Required	Type	Description
continuationToken	query		string	A token for retrieving the next page of results.

Responses

Name	Type	Description
200 OK	ExternalDataShares	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred.

Name

Type

Description

200 OK

ExternalDataShares

Request completed successfully.

Other Status Codes

ErrorResponse

Common error codes:

UnknownError - An error occurred.

Examples

List external data shares in the tenant example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items/externalDataShares

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "dccc162f-7a41-4720-83c3-5c7e81187959",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@contoso.com"
        }
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "Pending",
      "expirationTimeUtc": "2024-12-13T00:00:00.000Z",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "itemId": "5b218778-e7a5-4d73-8187-f10824047715",
      "invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=dccc162f-7a41-4720-83c3-5c7e81187959"
    },
    {
      "id": "96c21561-65b8-4b23-bb9a-ee8cef945c45",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@contoso.com"
        }
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "Active",
      "expirationTimeUtc": "2024-08-31T00:00:00.000Z",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "itemId": "5b218778-e7a5-4d73-8187-f10824047715",
      "invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=96c21561-65b8-4b23-bb9a-ee8cef945c45",
      "acceptedByTenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
    },
    {
      "id": "0f40aeca-8f78-4a6f-a552-e5c45faadc60",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
        "displayName": "Eric Solomon",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "eric@contoso.com"
        }
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "InvitationExpired",
      "expirationTimeUtc": "2024-01-01T00:00:00.000Z",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "itemId": "5b218778-e7a5-4d73-8187-f10824047715",
      "invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=0f40aeca-8f78-4a6f-a552-e5c45faadc60"
    },
    {
      "id": "89e82a82-0140-4837-8eee-9c919e3e5952",
      "paths": [
        "Files/Sales/Contoso_Sales_2023"
      ],
      "creatorPrincipal": {
        "id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
        "displayName": "Eric Solomon",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "eric@contoso.com"
        }
      },
      "recipient": {
        "userPrincipalName": "lisa@fabrikam.com"
      },
      "status": "Revoked",
      "expirationTimeUtc": "2024-12-01T00:00:00.000Z",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "itemId": "5b218778-e7a5-4d73-8187-f10824047715",
      "invitationUrl": "https://app.fabric.microsoft.com/externaldatasharing/accept?providerTenantId=34f92457-fe9d-4c36-92a8-499fdfaf0f8f&shareId=89e82a82-0140-4837-8eee-9c919e3e5952",
      "acceptedByTenantId": "c51dc03f-268a-4da0-a879-25f24947ab8b"
    }
  ]
}

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ExternalDataShare	An external data share object.
ExternalDataShareRecipient	A representation of the the external data share recipient.
ExternalDataShares	A list of external data shares with a continuation token.
ExternalDataShareStatus	The status of a given external data share. Additional `ExternalDataShareStatus` types may be added over time.
GroupDetails	Group specific details. Applicable when the principal type is `Group`.
GroupType	The type of the group. Additional group types may be added over time.
Principal	Represents an identity or a Microsoft Entra group.
PrincipalType	The type of the principal. Additional principal types may be added over time.
ServicePrincipalDetails	Service principal specific details. Applicable when the principal type is `ServicePrincipal`.
ServicePrincipalProfileDetails	Service principal profile details. Applicable when the principal type is `ServicePrincipalProfile`.
UserDetails	User principal specific details. Applicable when the principal type is `User`.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

ExternalDataShare

Object

An external data share object.

Name	Type	Description
acceptedByTenantId	string (uuid)	The tenant ID in which the external data share was accepted.
creatorPrincipal	Principal	The principal that created the external data share.
expirationTimeUtc	string (date-time)	The expiration date and time (UTC) of the invitation to the external data share.
id	string (uuid)	The external data share ID.
invitationUrl	string (uri)	The URL for accepting the invitation to the external data share.
itemId	string (uuid)	The item ID.
paths	string[]	The path or list of paths that are externally shared.
recipient	ExternalDataShareRecipient	The recipient who was invited to accept the external data share.
status	ExternalDataShareStatus	The status of the external data share.
workspaceId	string (uuid)	The workspace ID.

ExternalDataShareRecipient

Object

A representation of the the external data share recipient.

Name	Type	Description
tenantId	string (uuid)	The recipient's tenant ID.
userPrincipalName	string maxLength: 256	The recipient's email address.

ExternalDataShares

Object

A list of external data shares with a continuation token.

Name	Type	Description
continuationToken	string	The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri	string	The URI of the next result set batch. If there are no more records, it's removed from the response.
value	ExternalDataShare[]	A list of external data shares.

ExternalDataShareStatus

Enumeration

The status of a given external data share. Additional ExternalDataShareStatus types may be added over time.

Value	Description
Pending	An invitation was created and is now pending acceptance by the recipient.
Active	The invitation has been accepted by the recipient and the external data share is active.
Revoked	The external data share was revoked.
InvitationExpired	The invitation expired and can no longer be accepted by the recipient.

GroupDetails

Object

Group specific details. Applicable when the principal type is Group.

Name	Type	Description
groupType	GroupType	The type of the group. Additional group types may be added over time.

GroupType

Enumeration

The type of the group. Additional group types may be added over time.

Value	Description
Unknown	Principal group type is unknown.
SecurityGroup	Principal is a security group.
DistributionList	Principal is a distribution list.

Principal

Object

Represents an identity or a Microsoft Entra group.

Name	Type	Description
displayName	string	The principal's display name.
groupDetails	GroupDetails	Group specific details. Applicable when the principal type is `Group`.
id	string (uuid)	The principal's ID.
servicePrincipalDetails	ServicePrincipalDetails	Service principal specific details. Applicable when the principal type is `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Service principal profile details. Applicable when the principal type is `ServicePrincipalProfile`.
type	PrincipalType	The type of the principal. Additional principal types may be added over time.
userDetails	UserDetails	User principal specific details. Applicable when the principal type is `User`.

PrincipalType

Enumeration

The type of the principal. Additional principal types may be added over time.

Value	Description
User	Principal is a Microsoft Entra user principal.
ServicePrincipal	Principal is a Microsoft Entra service principal.
Group	Principal is a security group.
ServicePrincipalProfile	Principal is a service principal profile.

ServicePrincipalDetails

Object

Service principal specific details. Applicable when the principal type is ServicePrincipal.

Name	Type	Description
aadAppId	string (uuid)	The service principal's Microsoft Entra AppId.

ServicePrincipalProfileDetails

Object

Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.

Name	Type	Description
parentPrincipal	Principal	The service principal profile's parent principal.

UserDetails

Object

User principal specific details. Applicable when the principal type is User.

Name	Type	Description
userPrincipalName	string	The user principal name.

Share via

External Data Shares Provider - List External Data Shares

Permissions

Required Delegated Scopes

Required Tenant Settings

Limitations

Microsoft Entra supported identities

Interface

URI Parameters

Responses

Examples

List external data shares in the tenant example

Sample request

Sample response

Definitions

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExternalDataShare

ExternalDataShareRecipient

ExternalDataShares

ExternalDataShareStatus

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails