Skip to main content

ExternalDataShare

Properties

PropertyTypeAttributesDescription
itemIdstringRequired, IdentifierThe item ID
pathsstring[]RequiredThe paths to share. Each path must start with 'Files/' or 'Tables/' followed by a subpath - the root folder itself cannot be shared
recipientExternalDataShareRecipientRequiredThe recipient of the external data share
workspaceIdstringRequired, IdentifierThe Workspace ID
acceptedByTenantIdstringRead-onlyThe tenant ID that accepted the external data share
expirationTimestringRead-onlyThe expiration time of the external data share in UTC
idstringRead-only, IdentifierThe External Data Share ID
invitationUrlstringRead-onlyThe invitation URL for the external data share
principalModelExternalDataSharePrincipalRead-onlyThe creator principal of the external data share
status'Active' | 'InvitationExpired' | 'Pending' | 'Revoked'Read-onlyThe status of the external data share

ExternalDataShareRecipient

PropertyTypeAttributesDescription
tenantIdstringThe tenant ID of the recipient. Required when type is ServicePrincipal, optional when type is User
type'User' | 'ServicePrincipal'The type of the recipient. Defaults to User
userPrincipalNamestringThe user principal name of the recipient. Required when type is User

ExternalDataSharePrincipal

PropertyTypeAttributesDescription
idstringRead-onlyThe ID of the creator principal
typestringRead-onlyThe type of the creator principal