Aide du Hub TheSocle · apim.scopes.ecran

Catalogue des scopes

Les permissions qu'une clé API peut porter, sous la forme api:<slug>:<verbe>. Chaque API exige l'une d'elles.

Voir l'élément dans l'écran : hub/apim/scopes

Explication

Un scope est un droit nommé. Une API en exige un ; une clé en porte une liste. La passerelle laisse passer l'appel si la clé porte le scope de l'API, ou un scope plus large qui le couvre.

La forme est api:<slug de l'API>:<verbe> :

Verbe Couvre
read la lecture (GET, HEAD)
write l'écriture (POST, PUT, PATCH)
admin la suppression et les opérations d'administration
* les trois à la fois

Le * est hiérarchique : api:notionsocle:* couvre api:notionsocle:read, et api:* couvre toutes les API.

Quand une API est publiée par le parcours guidé, ses quatre scopes sont créés d'office (source « 🤖 auto »). Les autres sont saisis à la main (« ✋ manuel »). Un clic sur une ligne montre les API qui exigent ce scope et les clés qui le portent.

Fiche complète

Ce que l'écran appelle

Moment Requête
ouverture GET /api/apim/admin/scopes
clic sur une ligne GET /api/apim/admin/scopes/by-scope/{scope}
🔄 Recompute stats POST /api/apim/admin/scopes/recompute-stats

Autres routes, sans bouton à l'écran

POST /api/apim/admin/scopes (créer), PATCH /api/apim/admin/scopes/{id} (nom, description, sensibilité), DELETE /api/apim/admin/scopes/{id}, POST /api/apim/admin/scopes/auto-generate/{apiId}, GET /api/apim/admin/scopes/for-api/{apiId}, GET /api/apim/admin/scopes/for-tenant/{tenantId}.

Par MCP

apim_provisioning_worker.list_api_scopes.

Sommaire du démonstrateur