Microsoft Fabric Users API

openapi: 3.2.0
info:
  title: Microsoft Fabric Admin REST Users 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: Users
paths:
  /users/{userId}/access:
    get:
      summary: Returns a list of permission details for Fabric and PowerBI items the specified…
      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 pagination. A maximum of 10,000 records can be returned per request. With the continuous token provided in the response, you can get the next 10,000 records.


        Page order:

        1. Fabric items

        2. Datamarts

        3. Reports

        4. Dashboards

        5. SemanticModels

        6. Apps

        7. Dataflows


        ## Permissions


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


        ## Required Delegated Scopes


        Tenant.Read.All or Tenant.ReadWrite.All


        ## Limitations


        Maximum 200 requests per hour.


        ## 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:
      - Users
      operationId: Users_ListAccessEntities
      x-ms-pageable:
        nextLinkName: continuationUri
        itemName: accessEntities
      parameters:
      - in: path
        name: userId
        description: The user graph ID or User Principal Name (UPN).
        required: true
        schema:
          type: string
      - in: query
        name: type
        description: The item type.
        required: false
        schema:
          type: string
      - in: query
        name: continuationToken
        description: Continuous token used to get the next page items.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The operation was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessEntityResponse'
        '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:


            * InvalidPrincipal - User ID doesn''t exist in Microsoft Entra, or the caller doesn''t have permissions to call the API.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ItemAccessDetail:
      type: object
      description: 'Item permission details such as *read* and *reshare*. '
      properties:
        type:
          $ref: '#/components/schemas/ItemType'
        permissions:
          type: array
          description: Item permissions such as *read* and *reshare*.
          items:
            $ref: '#/components/schemas/ItemPermissions'
        additionalPermissions:
          type: array
          description: Workload permissions such as *readAll* and *viewOutput*.
          items:
            type: string
    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
    ItemPermissions:
      type: string
      description: Item permissions. Additional item permissions may be added over time.
      enum:
      - Read
      - Write
      - Reshare
      - Explore
      - Execute
      x-ms-enum:
        name: ItemPermissions
        modelAsString: true
        values:
        - value: Read
          description: User can read the metadata about an item.
        - value: Write
          description: User can perform write operations on an item.
        - value: Reshare
          description: User can share an item with other users.
        - value: Explore
          description: User can build items on other items.
        - value: Execute
          description: User can execute and cancel item jobs.
    AccessEntityResponse:
      description: A list of entities and permissions.
      properties:
        accessEntities:
          type: array
          description: A list of users with access to an entity.
          items:
            $ref: '#/components/schemas/AccessEntity'
      allOf:
      - $ref: '#/components/schemas/PaginatedResponse'
    AccessEntity:
      description: Access details for the given user.
      properties:
        displayName:
          type: string
          description: Entity name.
        id:
          type: string
          format: uuid
          readOnly: true
          description: The object ID of the entity.
        category:
          $ref: '#/components/schemas/Category'
        type:
          type: string
          description: Entity type.
        itemAccessDetails:
          $ref: '#/components/schemas/ItemAccessDetail'
    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
    Category:
      type: string
      description: The category of the item type. Additional category types may be added over time.
      enum:
      - Item
      x-ms-enum:
        name: Category
        modelAsString: true
        values:
        - value: Item
          description: Fabric items such as Notebook, Synapse and KQL Database.
    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
    PaginatedResponse:
      properties:
        continuationToken:
          type: string
          description: The token for the next result set batch. If there are no more records, it's removed from the response.
        continuationUri:
          type: string
          description: The URI of the next result set batch. If there are no more records, it's removed from the response.
    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