Microsoft Fabric Sharing Links API

openapi: 3.2.0
info:
  title: Microsoft Fabric Admin REST Sharing Links API
  version: v1
  x-source: 'https://github.com/microsoft/fabric-rest-api-specs (bundled from openapi/_original/fabric-rest-api-specs: admin/swagger.json)'
servers:
- url: https://api.fabric.microsoft.com/v1/admin
security: []
tags:
- name: SharingLinks
paths:
  /items/removeAllSharingLinks:
    post:
      summary: Deletes all organization sharing links for all Fabric items in the tenant.
      description: '> [!NOTE]

        > This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.


        This API supports long running operations (LRO).


        Use LinksSharedToWholeOrganization PowerBI Admin REST API to get Power BI Reports shared via organizational sharing links.


        ## Permissions


        The caller must be a Fabric administrator.


        ## Required Delegated Scopes


        Tenant.ReadWrite.All


        ## Limitations


        - Maximum 10 requests per minute.

        - Only Power BI Reports are supported.


        ## 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'
      tags:
      - SharingLinks
      operationId: SharingLinks_RemoveAllSharingLinks
      x-ms-fabric-sdk-long-running-operation: true
      responses:
        '200':
          description: Request completed successfully.
        '202':
          description: Request accepted. Retrieving the definition is in progress.
          headers:
            Location:
              description: The URL of the operation status, which can be used to track the operation state.
              schema:
                type: string
            x-ms-operation-id:
              description: The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.
              schema:
                type: string
                format: uuid
            Retry-After:
              description: The number of seconds to wait before retrying the request.
              schema:
                type: integer
        '429':
          description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
          x-ms-error-response: true
          headers:
            Retry-After:
              description: The number of seconds to wait before retrying the request.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: 'Common error codes:


            * Forbidden - The caller doesn''t have permissions to call the API.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveAllSharingLinksRequest'
        description: Type of sharing links to be removed.
        required: true
  /items/bulkRemoveSharingLinks:
    post:
      summary: Deletes all organization sharing links for the specified Fabric items.
      description: '> [!NOTE]

        > This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.


        This API supports long running operations (LRO).


        Use LinksSharedToWholeOrganization PowerBI Admin REST API to get Power BI Reports shared via organizational sharing links.


        ## Permissions


        The caller must be a Fabric administrator.


        ## Required Delegated Scopes


        Tenant.ReadWrite.All


        ## Limitations


        - Maximum 10 requests per minute.

        - Each request can delete organization sharing links for up to 500 Fabric items.

        - Only Power BI Reports are supported.


        ## 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'
      tags:
      - SharingLinks
      operationId: SharingLinks_BulkRemoveSharingLinks
      x-ms-fabric-sdk-long-running-operation: true
      responses:
        '200':
          description: Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkRemoveSharingLinksResponse'
        '202':
          description: Request accepted. Retrieving the definition is in progress.
          headers:
            Location:
              description: The URL of the operation status, which can be used to track the operation state.
              schema:
                type: string
            x-ms-operation-id:
              description: The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.
              schema:
                type: string
                format: uuid
            Retry-After:
              description: The number of seconds to wait before retrying the request.
              schema:
                type: integer
        '429':
          description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
          x-ms-error-response: true
          headers:
            Retry-After:
              description: The number of seconds to wait before retrying the request.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: 'Common error codes:


            * Forbidden - The caller doesn''t have permissions to call the API.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRemoveSharingLinksRequest'
        description: A list of items.
        required: true
components:
  schemas:
    ItemType:
      description: The type of the item. Additional item types may be added over time.
      type: string
      enum:
      - Dashboard
      - Report
      - SemanticModel
      - PaginatedReport
      - Datamart
      - Lakehouse
      - Eventhouse
      - Environment
      - KQLDatabase
      - KQLQueryset
      - KQLDashboard
      - DataPipeline
      - Notebook
      - SparkJobDefinition
      - MLExperiment
      - MLModel
      - Warehouse
      - Eventstream
      - SQLEndpoint
      - MirroredWarehouse
      - MirroredDatabase
      - Reflex
      - GraphQLApi
      - MountedDataFactory
      - SQLDatabase
      - CopyJob
      - VariableLibrary
      - Dataflow
      - ApacheAirflowJob
      - WarehouseSnapshot
      - DigitalTwinBuilder
      - DigitalTwinBuilderFlow
      - MirroredAzureDatabricksCatalog
      - Map
      - AnomalyDetector
      - UserDataFunction
      - GraphModel
      - GraphQuerySet
      - SnowflakeDatabase
      - OperationsAgent
      - CosmosDBDatabase
      - Ontology
      - EventSchemaSet
      - DataAgent
      - MirroredCatalog
      - PolicySet
      - AppBackend
      - OrgApp
      - OrgAppAudience
      - DataBuildToolJob
      - AzureDatabricksStorage
      - Plan
      - Monitoring
      - DeploymentPlan
      x-ms-enum:
        name: ItemType
        modelAsString: true
        values:
        - value: Dashboard
          description: PowerBI dashboard.
        - value: Report
          description: PowerBI report.
        - value: SemanticModel
          description: PowerBI semantic model.
        - value: PaginatedReport
          description: PowerBI paginated report.
        - value: Datamart
          description: PowerBI datamart.
        - value: Lakehouse
          description: A lakehouse.
        - value: Eventhouse
          description: An eventhouse.
        - value: Environment
          description: An environment.
        - value: KQLDatabase
          description: A KQL database.
        - value: KQLQueryset
          description: A KQL queryset.
        - value: KQLDashboard
          description: A KQL dashboard.
        - value: DataPipeline
          description: A data pipeline.
        - value: Notebook
          description: A notebook.
        - value: SparkJobDefinition
          description: A spark job definition.
        - value: MLExperiment
          description: A machine learning experiment.
        - value: MLModel
          description: A machine learning model.
        - value: Warehouse
          description: A warehouse.
        - value: Eventstream
          description: An eventstream.
        - value: SQLEndpoint
          description: An SQL endpoint.
        - value: MirroredWarehouse
          description: A mirrored warehouse.
        - value: MirroredDatabase
          description: A mirrored database.
        - value: Reflex
          description: A Reflex.
        - value: GraphQLApi
          description: An API for GraphQL item.
        - value: MountedDataFactory
          description: A MountedDataFactory.
        - value: ApacheAirflowJob
          description: An ApacheAirflowJob.
        - value: SQLDatabase
          description: A SQLDatabase.
        - value: CopyJob
          description: A Copy job.
        - value: VariableLibrary
          description: A VariableLibrary.
        - value: MirroredAzureDatabricksCatalog
          description: A mirrored azure databricks catalog.
        - value: Dataflow
          description: A Dataflow.
        - value: WarehouseSnapshot
          description: A Warehouse snapshot.
        - value: DigitalTwinBuilder
          description: A DigitalTwinBuilder.
        - value: DigitalTwinBuilderFlow
          description: A Digital Twin Builder Flow.
        - value: AnomalyDetector
          description: An Anomaly Detector.
        - value: Map
          description: A Map.
        - value: Ontology
          description: An Ontology.
        - value: UserDataFunction
          description: A User Data Function.
        - value: GraphModel
          description: A GraphModel.
        - value: GraphQuerySet
          description: A Graph QuerySet.
        - value: SnowflakeDatabase
          description: A Snowflake Database to store Iceberg tables created from Snowflake account.
        - value: OperationsAgent
          description: A OperationsAgent.
        - value: CosmosDBDatabase
          description: A Cosmos DB Database.
        - value: EventSchemaSet
          description: An EventSchemaSet.
        - value: DataAgent
          description: A DataAgent.
        - value: MirroredCatalog
          description: A MirroredCatalog.
        - value: PolicySet
          description: A PolicySet.
        - value: AppBackend
          description: An AppBackend.
        - value: OrgApp
          description: An Org App.
        - value: OrgAppAudience
          description: An Org App Audience.
        - value: DataBuildToolJob
          description: A DataBuildToolJob.
        - value: AzureDatabricksStorage
          description: A OneLake-backed storage item for Azure Databricks.
        - value: Plan
          description: A plan.
        - value: Monitoring
          description: A Monitoring item.
        - value: DeploymentPlan
          description: A Deployment plan.
    ErrorResponse:
      description: The error response.
      required:
      - message
      - errorCode
      allOf:
      - $ref: '#/components/schemas/ErrorResponseDetails'
      properties:
        requestId:
          type: string
          format: uuid
          description: ID of the request associated with the error.
          readOnly: true
        moreDetails:
          description: List of additional error details.
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseDetails'
          readOnly: true
        isRetriable:
          type: boolean
          description: When true, the request can be retried. Use the `Retry-After` response header to determine the delay, if available.
          readOnly: true
    ItemInfo:
      description: The item information, including item ID and type.
      type: object
      required:
      - id
      - type
      properties:
        id:
          type: string
          description: An ID in UUID format.
          format: uuid
        type:
          $ref: '#/components/schemas/ItemType'
    ErrorParameter:
      description: A structured parameter providing additional machine-readable context about an error.
      type: object
      properties:
        name:
          type: string
          description: The parameter identifier.
          readOnly: true
        value:
          type: string
          description: The parameter value.
          readOnly: true
        message:
          type: string
          description: A human-readable description of the parameter's meaning.
          readOnly: true
    ItemRemoveSharingLinksStatus:
      description: The unique ID and sharing links removal status of a Fabric item
      required:
      - status
      allOf:
      - $ref: '#/components/schemas/ItemInfo'
      properties:
        status:
          $ref: '#/components/schemas/SharingLinksRemovalStatus'
    SharingLinksRemovalStatus:
      type: string
      description: The status of removal of sharing links. Additional `SharingLinksRemovalStatus` types may be added over time.
      enum:
      - Succeeded
      - NotFound
      x-ms-enum:
        name: SharingLinksRemovalStatus
        modelAsString: true
        values:
        - value: NotFound
          description: The Fabric item ID, label or type wasn't found.
        - value: Succeeded
          description: All sharing links were removed.
    BulkRemoveSharingLinksResponse:
      description: A list of the unique IDs and sharing links removal status of the Fabric items in remove sharing links request
      properties:
        itemsRemoveSharingLinksStatus:
          type: array
          description: A list of items remove sharing link status.
          items:
            $ref: '#/components/schemas/ItemRemoveSharingLinksStatus'
        sharingLinkType:
          $ref: '#/components/schemas/SharingLinkType'
    SharingLinkType:
      type: string
      description: Specifies the type of sharing link that is required to be deleted for each Fabric item. Additional sharing link types may be added over time.
      enum:
      - OrgLink
      x-ms-enum:
        name: SharingLinkType
        modelAsString: true
        values:
        - value: OrgLink
          description: The sharing link grants access to entire organization (default value).
    RemoveAllSharingLinksRequest:
      description: Accepts the type of sharing link to be removed for all Fabric items in organization.
      required:
      - sharingLinkType
      properties:
        sharingLinkType:
          $ref: '#/components/schemas/SharingLinkType'
    ErrorResponseDetails:
      description: The error response details.
      type: object
      required:
      - message
      - errorCode
      properties:
        errorCode:
          type: string
          description: A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
          readOnly: true
        message:
          type: string
          description: A human readable representation of the error.
          readOnly: true
        relatedResource:
          $ref: '#/components/schemas/ErrorRelatedResource'
        parameters:
          description: Structured parameters providing additional machine-readable context about the error.
          type: array
          items:
            $ref: '#/components/schemas/ErrorParameter'
          readOnly: true
    ErrorRelatedResource:
      description: The error related resource details object.
      type: object
      required:
      - resourceId
      - resourceType
      properties:
        resourceId:
          type: string
          description: The resource ID that's involved in the error.
          readOnly: true
        resourceType:
          type: string
          description: The type of the resource that's involved in the error.
          readOnly: true
    BulkRemoveSharingLinksRequest:
      description: A list of items for which all sharing links and related access is required to be removed. Also accepts the type of sharing link to be removed.
      required:
      - items
      - sharingLinkType
      properties:
        items:
          type: array
          description: A list of items. The list includes item ID and type.
          readOnly: false
          items:
            $ref: '#/components/schemas/ItemInfo'
        sharingLinkType:
          $ref: '#/components/schemas/SharingLinkType'