Skip to main content

List access policies

MethodPath
GET/v1/slim/policy

Authentication · Access policies

Lists the access policies (roles) of a project, each with the practitioners who hold it. Use it to render a roles table.

Auth: Bearer token for a practitioner, project admin or System Owner session. The caller's access policy must grant Practitioner:create, the right to invite users (project admins skip this check). Scope: The caller's project (from the token), or projectId when given. projectId must be the caller's project or a direct child of it.

Behaviour​

  • Each row is { policy, members }. members lists only Practitioner members, as { reference, display }.
  • profile keeps only the policies held by that member, given as a reference such as Practitioner/<id>.
  • sortBy is _id (default), _lastUpdated or name; orderBy is ASC (default) or DESC. Rows with an empty sort value go last in ASC and first in DESC.
  • Paging is in memory: page (default 0) and count (default 20, 1 to 100). total counts the rows after filtering, before paging.

Example​

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/policy?sortBy=name&orderBy=ASC&page=0&count=20' \
-H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response​

200 — Access policies retrieved successfully.

Errors​

StatusMeaning
400The session carries no project.
401The bearer token is missing or invalid.
403The session is not a practitioner, admin or System Owner session, its access policy lacks Practitioner:create, or projectId is neither the caller's project nor a direct child of it.
422A query parameter fails validation.