The Open API specification for Synapse is now available for download!

Download Open API Spec

GET /entity/{id}/access

Determine if the caller have a given permission on a given Entity.

A User's permission on an Entity is a calculation based several factors including the permission granted by the Entity's ACL and the User's group membership. There might also be extra requirement for an Entity, such as special terms-of-use or special restrictions for sensitive data. This means a client cannot accurately calculate a User's permission on an Entity simply by inspecting the Entity's ACL. Instead, all clients should use this method to get the calculated permission a User has on an Entity.

Resource URL

https://repo-prod.prod.sagebase.org/repo/v1/entity/{id}/access

Resource URL Variables
{id} The ID of the Entity to check the permission on.
Parameters
accessType

optional

The permission to check. Must be from: ACCESS_TYPE
Resource Information
Authentication Required
Required OAuth Scopes view
HTTP Method GET
Request Object None
Response Object None