OAuth-Scopes-Referenz

OAuth-Scopes sind Ebene 1 des Sicherheitsmodells: Sie definieren, welche Arten von Operationen Ihre OAuth-Anwendung ausführen darf. Diese Seite listet jeden Scope und was er gewährt.

---

Scopes

Scope	Gewährt
read:basic	Lesen von grundlegenden Profil-, Organisations- und API-Discovery-Informationen. Erforderlich für GET /oauth/api-info; siehe den Hinweis unten.
read:hierarchy	Lesen von Datenknoten und Site-Hierarchie.
write:hierarchy	Umbenennen, Verschieben oder Löschen von Datenknoten.
read:bundle	Lesen von Data Bundles, deren Verarbeitungsstatus und Eingabedateien.
write:bundle	Erstellen von Data Bundles und Verwalten ihrer Uploads und Verarbeitung.
read:poi	Lesen von Points of Interest (POIs).
write:poi	Erstellen, Aktualisieren oder Löschen von Points of Interest (POIs).
read:zone	Lesen von Zonen.
write:zone	Erstellen, Aktualisieren oder Löschen von Zonen.
read:asset	Lesen von RealityAssets und Asset-Typen.
write:asset	Erstellen, Aktualisieren oder Löschen von RealityAssets und deren Metadaten.
search:objects	Suchen nach Geschäftsobjekten (Assets, POIs, Zonen) in einem Twin.
read:twin	Lesen von Twin- und RealityPlan-Spaces, Bundles und Layouts.
write:twin	Erstellen oder Aktualisieren von Twin-Entwürfen.
download:sitefile	Abrufen einer signierten Download-URL für eine Site-Datei.
write:sitefile	Erstellen und Hochladen von Site-Dateien.
download:scan	Reserviert; steuert derzeit keinen Endpunkt.
read:assetlibrary	Lesen von Asset-Library-Modellen und -Tags.
write:assetlibrary	Erstellen, Aktualisieren oder Löschen von Asset-Library-Modellen und -Tags.
download:assetlibrary	Abrufen signierter Download-Links oder Vorschaubilder für ein Asset-Library-Modell.
read:assetsettings	Lesen von Asset-Einstellungen.
write:assetsettings	Reserviert; steuert derzeit keinen Endpunkt.
read:user	Lesen von Benutzern.
write:user	Erstellen, Aktualisieren oder Löschen von Benutzern.
read:invitation	Lesen von Einladungen.
write:invitation	Erstellen von Einladungen.

Tipp

Fast jede Integration benötigt read:basic, selbst wenn sie nie eine Operation aufruft, die diesen Scope explizit listet. GET /oauth/api-info (der Aufruf, den fast jeder Leitfaden auf dieser Website verwendet, um Ihre regionale API-URL und Organisations-ID zu ermitteln) erfordert read:basic. Gewähren Sie diesen Scope standardmäßig: Ohne ihn erhält eine Anwendung bereits beim allerersten Aufruf nach Erhalt eines Tokens die Antwort 403.

Wie geht es weiter?

• Erkunden Sie die API-Referenz für den genauen Scope, den jede Operation erfordert.