Restreindre les portées d’API avec des modificateurs de portée

Un modificateur de portée réduit une portée d’API à un sous-ensemble de ses opérations. Pour ajouter un modificateur, ajoutez-le au nom du scope après un deux-points, par clusters:readexemple . Un scope sans modificateur permet toutes les opérations dans le périmètre.

Vous pouvez utiliser des modificateurs de portée dans :

Pour la liste complète des périmètres et des opérations API que chacun couvre, voir les champs d’application des API.

Modificateurs disponibles

  • :read: N’autorise que les opérations de lecture du périmètre (GET et HEAD requêtes). Par exemple, clusters:read permet de lister et d’obtenir des clusters sans les créer, modifier ou supprimer.
  • :restricted-query: Permet les requêtes SQL en lecture seule. Ce modificateur s’applique uniquement au périmètre sql. Un jeton avec sql:restricted-query peut exécuter des requêtes telles que SELECT et DESCRIBE avec l’API d’exécution de l’instruction ainsi que les pilotes et connecteurs SQL. Il ne peut pas appeler d’autres API SQL, comme lister les entrepôts SQL. Les instructions qui modifient des objets ou des données échouent :
    • Les instructions qui créent, modifient ou suppriment des objets, telles que CREATE TABLE et DROP TABLE, échouent avec [OP_NOT_SUPPORTED_READ_ONLY] ... is not supported in read-only session mode. SQLSTATE: 42KD1.
    • Les instructions qui modifient des données, telles que INSERT et UPDATE, échouent avec [INSUFFICIENT_PERMISSIONS] Insufficient privileges, même sur des tables que vous possédez.

Pour combiner les modificateurs, ajoutez les deux : sql:read:restricted-query permet les opérations de lecture du périmètre sql, telles que la liste des entrepôts SQL et les requêtes en lecture seule.

Sélectionnez un niveau d’accès dans l’interface utilisateur

Lorsque vous générez un jeton d’accès personnel ou un secret OAuth dans l’interface de l’espace de travail, après avoir ajouté un périmètre, sélectionnez son niveau d’accès. Le niveau d’accès définit le modificateur :

Niveau d’accès Portée accordée
Lire <scope>:read
Lire + Écrire <scope> (pas de modificateur)
Requête restreinte (sql uniquement) sql:restricted-query
Lecture + requête restreinte (sql seule) sql:read:restricted-query
Lecture + requête restreinte + écriture (sql uniquement) sql (pas de modificateur)

Utilisez des modificateurs avec des jetons d’accès personnels

Avec l’API Token, incluez chaque scope avec ses modificateurs comme un élément du scopes tableau. Les jetons d’accès personnels ne prennent pas en charge all-apis:read. Pour accorder un accès complet à l’espace de travail, utilisez un tableau vide scopes (le scope all-apis). Consultez les jetons d’accès personnels attribués.

Utilisez des modificateurs avec OAuth

Vous pouvez lier un secret OAuth de principal de service à des scopes avec des modificateurs, et vous pouvez demander un jeton d’accès OAuth avec des scopes avec modificateurs. Un jeton d’accès ne peut pas dépasser la portée du secret dont il a été émis, sauf pour un secret avec la portée authentication. Voir les secrets OAuth à portée limitée. OAuth accepte all-apis:readégalement , ce qui permet des opérations de lecture sur chaque API pour laquelle le principal est autorisé.

Pour demander un jeton avec des modificateurs, listez les portées dans le paramètre scope de la requête de jeton, séparées par des espaces. Dans l’URL d’autorisation du flux utilisateur-machine, séparez les périmètres avec + à la place.

Ressources supplémentaires