...
| action | uri | HTTP method | Schema | Authorization |
|---|---|---|---|---|
| create AccessRequirement | /accessRequirement | POST | extension of AccessRequirement.json | ACT membership; anyone with create or update access to the entity(ies) covered by the AccessRequirement* |
| read paginated list of all AccessRequirement objects for an entity | /entity/{entityId}/accessRequirement | GET | VariableContentPaginatedResults<AccessRequirement> | ALL |
| retrieve paginated list of unfufilled access requirements for an entity | /entity/{entityId}/accessRequirementUnfulfilled | GET | VariableContentPaginatedResults<AccessRequirement> | ALL |
| delete AccessRequirement (along with all approvals granted for the requirement) | /accessRequirement/{accessRqmtId} | DELETE | ---- | ACT membership |
| create AccessApproval | /accessApproval | POST | TermsOfUseAccessApproval.json | ALL |
| ACTAccessApproval.json | ACT membership | |||
| read all AccessApproval objects for a given entity | /entity/{entityId}/accessApproval | GET | VariableContentPaginatedResults<AccessApproval> | ACT membership |
| delete AccessApproval | /accessApproval/{accessApprovalid} | DELETE | -- | ACT membership |
...
membershi
|
* The ability for a non-ACT member to create an AccessRequirement is a Synapse requirement: Upon upload of restricted data (i.e. creating or updating a Locationable entity) one must be able to restrict access immediately.
Web UI
When a user clicks Download on the page for a Data object having a Terms of Use access requirement, they are presented with a dialog showing the text from the access requirement, as shown below. If they accept the terms, then an access approval is created and the Download link is presented.
...