Ga naar inhoud

Scopes en rechten

Elke operatie van /v1 vraagt een scope. De scope staat in de spec (x-prudai-scopes), en dus ook in de referentie bij elke operatie.

<product>:<object>:<verb>

Bijvoorbeeld prudai:sources:read of account:organizations:read. Het werkwoord is read, write of delete, en bepaalt meteen de klasse voor goedkeuringen:

WerkwoordBetekenisGoedkeuring
readVerandert geen gedeeld object. Ook een POST die zoekt of controleert valt hieronder.Geen
writeMaakt of wijzigt iets.Altijd een mens
deleteVerwijdert iets.Altijd een mens

De actuele catalogus van het platform is openbaar:

Terminal window
curl -s https://api.prudai.com/v1/scopes

Per product is de catalogus uit de spec afgeleid: Prudai Developer API, IRMA (alleen voor Prudai-medewerkers, inloggen vereist) en ORDO (alleen voor Prudai-medewerkers, inloggen vereist).

  • Wildcard: alleen op de plaats van het object, zoals prudai:*:read. Een wildcard dekt per aanroep elke uitgeefbare scope van dat product en werkwoord, behalve objecten die alleen expliciet te krijgen zijn. Die staan zo gemarkeerd in de catalogus.
  • Bundel: wordt bij het uitgeven van een sleutel uitgeklapt tot losse scopes. Een bundel is geen wildcard en krijgt later geen nieuwe rechten.
AanroeperRechten
ServicesleutelAlleen de scopes op de sleutel, binnen de organisatie van de sleutel.
Gebruiker via inloggenDe rechten van die gebruiker in de app. Het token kan die alleen beperken, nooit uitbreiden.

Een aanroep zonder de juiste scope krijgt 403 insufficient_scope, met de vereiste scope in details.required_scope. Zie Fouten.

Interne scopes voor Prudai-medewerkers zijn nooit toe te kennen aan een klantsleutel.

Eén structuur voor de app, de API, de CLI en MCP. Het effectieve recht is de doorsnede van vier lagen, daarna volgen twee controles:

  1. Productrecht van de organisatie: wat de organisatie heeft afgenomen.
  2. Organisatiebeleid: wat de organisatie zelf uitsluit.
  3. Rollen van de gebruiker: rollen zijn gegevens in één register, producten kennen alleen scopes.
  4. Tokenscope: wat dit token mag.
  5. Rechten op het object: bijvoorbeeld of je dit dossier mag zien.
  6. Goedkeuring: of er een mens moet meekijken.

Weigeren wint: ontbreekt een gegeven of is een scope onbekend, dan is het antwoord nee.