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

Download Open API Spec

AccessRequirementSearchRequest

org.sagebionetworks.repo.model.dataaccess.AccessRequirementSearchRequest

Describes the parameters for searching Access Requirements

Field Type Description
nameContains STRING Optional substring used to filter Access Requirements by name
ids ARRAY<INTEGER> Optional list of ids used to filter access requirements with specific ids.
relatedProjectId STRING Optional id used to filter Access Requirements to retrieve only those that have been applied within a particular project.
reviewerId STRING Optional principal ID used to filter Access Requirements to retrieve only those that can be reviewed by the specific reviewer.
accessType ACCESS_TYPE The enumeration of possible permission.
type STRING Optional filter by the access requirement fully qualified concrete type (e.g. org.sagebionetworks.repo.model.ManagedACTAccessRequirement)
sort ARRAY<AccessRequirementSearchSort>
nextPageToken STRING A token used to get the next page of a particular search query.