Référence des scopes OAuth

Les scopes OAuth constituent la couche 1 du modèle de sécurité : ils définissent les familles d’opérations que votre application OAuth est autorisée à effectuer. Cette page liste chaque scope et ce qu’il accorde.

---

Scopes

Scope	Autorise
read:basic	Lire les informations de base sur le profil, l’organisation et la découverte d’API. Requis pour GET /oauth/api-info ; voir l’encadré ci-dessous.
read:hierarchy	Lire les nœuds de données et la hiérarchie des sites.
write:hierarchy	Renommer, déplacer ou supprimer des nœuds de données.
read:bundle	Lire les Data Bundles, leur statut de traitement et leurs fichiers d’entrée.
write:bundle	Créer des Data Bundles et gérer leurs téléversements et leur traitement.
read:poi	Lire les points d’intérêt (POI).
write:poi	Créer, mettre à jour ou supprimer des points d’intérêt (POI).
read:zone	Lire les zones.
write:zone	Créer, mettre à jour ou supprimer des zones.
read:asset	Lire les RealityAssets et les types d’actifs.
write:asset	Créer, mettre à jour ou supprimer des RealityAssets et leurs métadonnées.
search:objects	Rechercher des objets métier (actifs, POI, zones) dans un twin.
read:twin	Lire les espaces twin et reality plan, les bundles et les dispositions.
write:twin	Créer ou mettre à jour des brouillons de twin.
download:sitefile	Obtenir une URL de téléchargement signée pour un fichier de site.
write:sitefile	Créer et téléverser des fichiers de site.
download:scan	Réservé ; ne conditionne actuellement aucun point de terminaison.
read:assetlibrary	Lire les modèles et tags de la bibliothèque d’actifs.
write:assetlibrary	Créer, mettre à jour ou supprimer des modèles et tags de la bibliothèque d’actifs.
download:assetlibrary	Obtenir des liens de téléchargement signés ou des miniatures pour un modèle de la bibliothèque d’actifs.
read:assetsettings	Lire les paramètres d’actif.
write:assetsettings	Réservé ; ne conditionne actuellement aucun point de terminaison.
read:user	Lire les utilisateurs.
write:user	Créer, mettre à jour ou supprimer des utilisateurs.
read:invitation	Lire les invitations.
write:invitation	Créer des invitations.

Astuce

Presque toutes les intégrations ont besoin de read:basic, même si elles n’appellent jamais une opération qui le liste explicitement. GET /oauth/api-info (l’appel que presque tous les guides de ce site utilisent pour résoudre votre URL d’API régionale et l’ID de votre organisation) requiert read:basic. Accordez-le par défaut ; une application qui en est privée reçoit une erreur 403 dès le premier appel suivant l’obtention d’un jeton.

Et ensuite ?

• Explorez la référence API pour connaître le scope exact requis par chaque opération.