Enforce an Oso Policy
To use an Oso policy in your app, you’ll need to “enforce” it. A policy is useless without an app that consults the policy on user actions. For most apps, policies can be enforced on multiple “levels”:
- Resource-level: is the user allowed to perform this action on a particular resource?
- Field-level: which fields on this object can the user read? Which ones can they update?
- Request-level: should this user even be able to hit this endpoint, regardless of the resources it involves?
Oso provides an API to enforce authorization at all levels, each of which are described in this guide.
Oso instance provides the following methods to enforce to make it easy to
enforce your policy in a number of situations:
authorize(actor, action, resource): Ensure that an actor can perform an action on a certain resource. Read about resource-level enforcement.
authorizeRequest(actor, request): Ensure that an actor is allowed to access a certain endpoint. Read about request-level enforcement.
authorizeField(actor, action, resource, field): Ensure that a actor can perform a particular action on one field of a given resource. Read about field-level enforcement.
authorizedActions(actor, resource): List the actions that
actoris allowed to take on
authorizedFields(actor, action, resource): List the fields that
actoris allowed to perform
We recommend starting out by reading about resource-level enforcement.