Create access policy
- Sandbox: available
- Staging: available
- Production: unknown
Creates an access policy (role) in your project and assigns it to the listed practitioners. Use it to define a new role.
Auth: Bearer token for a practitioner, project admin or System Owner session. The caller's access policy must grant AccessPolicy:create and ProjectMembership:update (a project admin who holds no access policy skips this check).
Scope: The policy is created in the caller's project (from the token).
Behaviour
- You cannot create a policy above your own rank. Ranks come from the policy name or its
basedOndisplay:System Owneris the highest, thenAdmin, then every other policy. Project admins rank as System Owner. - Ovok adds interactions the apps rely on:
Consent:read,search,create,update, always;DeviceUseStatementandEpisodeOfCare:read,search,create,update, when the policy may create or updatePatient;ProvenanceandAuditEvent:read,search, when the policy is namedAdminorSystem Owner.
membersare profile references such asPractitioner/<id>. Each listed member's membership in your project now points to the new policy, replacing the policy it held before. A member with no membership in your project is skipped.- You cannot list a member whose current role ranks above yours. A member ranks as every policy their membership holds now (
accessPolicyand anyaccessentries), each ranked by its name. A project admin (admin: true) ranks as System Owner. - The policy and the membership changes commit together. Past 49 membership changes they are written in two steps.
- The policy is then copied by name into each direct child project. A failed copy does not fail the request.
- Returns the created policy with its members, as in
GET /v1/slim/policy/{id}.
Example
curl -X POST 'https://api.sandbox.ovok.com/v1/slim/policy' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "policy": { "resourceType": "AccessPolicy", "name": "Night shift", "resource": [{ "resourceType": "Patient", "interaction": ["read", "search"] }] }, "members": [{ "reference": "Practitioner/c3499c27-2973-0a7f-807e-fb8676a92dcb", "display": "Max Mustermann" }] }'bearerAuthorizationBearer <JWT>application/json- body
Create a policy
policy*members*array<>Access policy created successfully.
application/json- response
policy*members*array<>curl -X POST 'https://api.sandbox.ovok.com/v1/slim/policy' \ -H 'Content-Type: application/json' \ -d '{ "policy": { "name": "string", "resourceType": "AccessPolicy", "resource": [ { "resourceType": "string", "interaction": [ "read" ] } ] }, "members": [ { "reference": "string", "display": "string" } ]}'{ "policy": { "resourceType": "AccessPolicy", "id": "string", "name": "string", "resource": [ { "resourceType": "string", "interaction": [ "string" ], "criteria": "string", "readonly": true } ], "meta": { "project": "string", "author": { "reference": "string" }, "lastUpdated": "string" } }, "members": [ { "reference": "string", "display": "string" } ]}List access policies GET
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 (a project admin who holds no access policy skips 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 ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/policy?sortBy=name&orderBy=ASC&page=0&count=20' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```
Get access policy GET
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 (a project admin who holds no access policy skips 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 ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/policy/c3499c27-2973-0a7f-807e-fb8676a92dcb' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```