Workspaces - List Workspace Access Details

Dienst:: Admin

API-Version:: v1

Gibt eine Liste von Benutzern (einschließlich Gruppen und ServicePrincipals) zurück, die Zugriff auf den angegebenen Arbeitsbereich haben.

Note

Diese API ist Teil einer Preview-Version und wird nur für Evaluierungs- und Entwicklungszwecke bereitgestellt. Sie kann sich basierend auf Feedback ändern und wird nicht für den Produktionseinsatz empfohlen.

Permissions

Der Aufrufer muss ein Fabric-Administrator sein oder sich mit einem Dienstprinzipal authentifizieren.

Erforderliche delegierte Bereiche

Tenant.Read.All oder Tenant.ReadWrite.All

Limitations

Maximal 200 Anforderungen pro Stunde.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity	Support
User	Yes
Service Principal und Verwaltete Identitäten	Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/users

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Antworten

Name Typ Beschreibung

200 OK

Name	Typ	Beschreibung
200 OK	WorkspaceAccessDetailsResponse	Der Vorgang wurde durchgeführt.
429 Too Many Requests	ErrorResponse	Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen `Retry-After` Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: EntityNotFound – Arbeitsbereichs-ID ist nicht vorhanden. Nicht ausreichendprivilegiert – Der Aufrufer verfügt nicht über berechtigungen, um die API aufzurufen.

WorkspaceAccessDetailsResponse

Der Vorgang wurde durchgeführt.

429 Too Many Requests

ErrorResponse

Der Dienstratengrenzwert wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

EntityNotFound – Arbeitsbereichs-ID ist nicht vorhanden.
Nicht ausreichendprivilegiert – Der Aufrufer verfügt nicht über berechtigungen, um die API aufzurufen.

Beispiele

List of users for given workspace ID example

Beispielanforderung

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/users

Beispiel für eine Antwort

Statuscode:: 200

{
  "accessDetails": [
    {
      "principal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      },
      "workspaceAccessDetails": {
        "type": "Workspace",
        "workspaceRole": "Admin"
      }
    },
    {
      "principal": {
        "id": "c7db8e03-c8cb-4d4c-9f64-1dcd327c9d3c",
        "displayName": "Caleb Foster",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "caleb@example.com"
        }
      },
      "workspaceAccessDetails": {
        "type": "Workspace",
        "workspaceRole": "Viewer"
      }
    },
    {
      "principal": {
        "id": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
        "displayName": "TestSecurityGroup",
        "type": "Group",
        "groupDetails": {
          "groupType": "SecurityGroup"
        }
      },
      "workspaceAccessDetails": {
        "type": "Workspace",
        "workspaceRole": "Contributor"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
EntireTenantPrincipal	Stellt einen Mandantenprinzipal dar.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
GroupDetails	Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp `Group`ist.
GroupPrincipal	Steht für eine Sicherheitsgruppe.
GroupType	Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.
PrincipalType	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.
ServicePrincipalDetails	Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp `ServicePrincipal`ist.
ServicePrincipalPrincipal	Stellt einen Microsoft Entra-Dienstprinzipal dar.
ServicePrincipalProfileDetails	Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp `ServicePrincipalProfile`ist.
ServicePrincipalProfilePrincipal	Stellt ein Dienstprinzipalprofil dar.
UserDetails	Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp `User`ist.
UserPrincipal	Stellt einen Microsoft Entra-Benutzerprinzipal dar.
WorkspaceAccessDetail	Details zu Arbeitsbereichsberechtigungen.
WorkspaceAccessDetails	Benutzerzugriffsdetails für den Arbeitsbereich.
WorkspaceAccessDetailsResponse	Eine Liste der Benutzer mit Zugriff auf eine bestimmte Entität.
WorkspaceRole	Eine Arbeitsbereichsrolle. Zusätzliche Arbeitsbereichsrollen können im Laufe der Zeit hinzugefügt werden.
WorkspaceType	Ein Arbeitsbereichstyp. Weitere Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

EntireTenantPrincipal

Objekt

Stellt einen Mandantenprinzipal dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
id	string (uuid)	Die ID des Prinzipals.
type	string: EntireTenant	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
isRetriable	boolean	Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den `Retry-After` Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

GroupDetails

Objekt

Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp Groupist.

Name	Typ	Beschreibung
groupType	GroupType	Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.

GroupPrincipal

Objekt

Steht für eine Sicherheitsgruppe.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
groupDetails	GroupDetails	Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp `Group`ist.
id	string (uuid)	Die ID des Prinzipals.
type	string: Group	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

GroupType

Enumeration

Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Unknown	Der Prinzipalgruppentyp ist unbekannt.
SecurityGroup	Prinzipal ist eine Sicherheitsgruppe.
DistributionList	Prinzipal ist eine Verteilerliste.

PrincipalType

Enumeration

Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

Wert	Beschreibung
User	Prinzipal ist ein Microsoft Entra-Benutzerprinzipal.
ServicePrincipal	Prinzipal ist ein Microsoft Entra-Dienstprinzipal.
Group	Prinzipal ist eine Sicherheitsgruppe.
ServicePrincipalProfile	Prinzipal ist ein Dienstprinzipalprofil.
EntireTenant	Prinzipal stellt alle Mandantenbenutzer dar.

ServicePrincipalDetails

Objekt

Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp ServicePrincipalist.

Name	Typ	Beschreibung
aadAppId	string (uuid)	Die Microsoft Entra AppId des Dienstprinzipals.

ServicePrincipalPrincipal

Objekt

Stellt einen Microsoft Entra-Dienstprinzipal dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
id	string (uuid)	Die ID des Prinzipals.
servicePrincipalDetails	ServicePrincipalDetails	Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp `ServicePrincipal`ist.
type	string: ServicePrincipal	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

ServicePrincipalProfileDetails

Objekt

Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp ServicePrincipalProfileist.

Name	Typ	Beschreibung
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Der übergeordnete Prinzipal des Dienstprinzipals.

ServicePrincipalProfilePrincipal

Objekt

Stellt ein Dienstprinzipalprofil dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
id	string (uuid)	Die ID des Prinzipals.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp `ServicePrincipalProfile`ist.
type	string: ServicePrincipalProfile	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

UserDetails

Objekt

Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp Userist.

Name	Typ	Beschreibung
userPrincipalName	string	Der Benutzerprinzipalname.

UserPrincipal

Objekt

Stellt einen Microsoft Entra-Benutzerprinzipal dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
id	string (uuid)	Die ID des Prinzipals.
type	string: User	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.
userDetails	UserDetails	Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp `User`ist.

WorkspaceAccessDetail

Objekt

Details zu Arbeitsbereichsberechtigungen.

Name	Typ	Beschreibung
type	WorkspaceType	Arbeitsbereichstyp.
workspaceRole	WorkspaceRole	Die Arbeitsbereichsrolle.

WorkspaceAccessDetails

Objekt

Benutzerzugriffsdetails für den Arbeitsbereich.

Name	Typ	Beschreibung
principal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Informationen über den Benutzer, der Zugriff auf die Entität hat.
workspaceAccessDetails	WorkspaceAccessDetail	Arbeitsbereichsberechtigungen für den Benutzer.

WorkspaceAccessDetailsResponse

Objekt

Eine Liste der Benutzer mit Zugriff auf eine bestimmte Entität.

Name	Typ	Beschreibung
accessDetails	WorkspaceAccessDetails[]	Eine Liste der Benutzer mit Zugriff auf eine Entität.

WorkspaceRole

Enumeration

Eine Arbeitsbereichsrolle. Zusätzliche Arbeitsbereichsrollen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Admin	Ermöglicht den Administratorzugriff auf den Arbeitsbereich.
Member	Ermöglicht den Mitgliedschaftszugriff auf den Arbeitsbereich.
Contributor	Aktiviert den Beitrag zum Arbeitsbereich.
Viewer	Aktiviert die Anzeige des Arbeitsbereichs.

WorkspaceType

Enumeration

Ein Arbeitsbereichstyp. Weitere Arbeitsbereichstypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Personal	Mein Ordner oder Mein Arbeitsbereich, der zum Verwalten von Benutzerelementen verwendet wird.
Workspace	Arbeitsbereich, der zum Verwalten der Fabric-Elemente verwendet wird.
AdminWorkspace	Administratorüberwachungsarbeitsbereich. Enthält Administratorberichte wie den Überwachungsbericht und den Nutzungs- und Einführungsbericht.