Skip to main content

Get access policy

MethodPath
GET/v1/slim/policy/:id

Authentication · Access policies

Returns one access policy (role) with the practitioners who hold it.

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 policy must belong to the caller's project (from the token), its parent project or one of its direct child projects.

Behaviour​

  • Returns { policy, members }. policy is the full AccessPolicy. members lists the Practitioner members whose membership points to it, as { reference, display }.

Example​

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/policy/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21' \
-H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response​

200 — Access policy retrieved successfully.

Errors​

StatusMeaning
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 the policy is outside the caller's project scope.
404No access policy has this id.
422id is not a UUID.