ManagedACTAccessRequirement
org.sagebionetworks.repo.model.ManagedACTAccessRequirement
JSON schema for in-Synapse 'Access Control Team' controlled Access Requirement, a 'tier 3' Access Requirement. This access requirement allows the ACT managing the detail requirements, and submissions within Synapse.
| Field | Type | Description |
|---|---|---|
| versionNumber | INTEGER | The version number issued to this version on the object. |
| id | INTEGER | The unique immutable ID. Provided by the system, the user may not set this field. |
| description | STRING | Depricated. Replaced by name. |
| name | STRING | Name of the AR. Limited to 50 characters and must be unique. Required. |
| etag | STRING | Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. Since the E-Tag changes every time an entity is updated it is used to detect when a client's current representation of an object is out-of-date. |
| createdOn | STRING | The date this object was created. Provided by the system, the user may not set this field. |
| modifiedOn | STRING | The date this object was last modified. Provided by the system, the user may not set this field. |
| createdBy | STRING | The user that created this object. Provided by the system, the user may not set this field. |
| modifiedBy | STRING | The user that last modified this object. Provided by the system, the user may not set this field. |
| subjectsDefinedByAnnotations | BOOLEAN | Defaults to 'false'. When 'true', the subjects controlled by this AR are defined by the the'_accessRequirementIds' annotations on individual entities. This property is mutually exclusive with 'subjectIds'. If this is set to 'true' then 'subjectIds' must be excluded or empty. |
| subjectIds | ARRAY<RestrictableObjectDescriptor> | The IDs of the items controlled by this Access Requirement when 'subjectsDefinedByAnnotations=false'. This property is mutually exclusive with 'subjectsDefinedByAnnotations'. When 'subjectsDefinedByAnnotations=true' then this property must be empty or excluded. Required when creating or updating and 'subjectsDefinedByAnnotations=false' or 'subjectsDefinedByAnnotations' is excluded. |
| accessType | ACCESS_TYPE | The enumeration of possible permission. |
| concreteType | STRING | Indicates which type of AccessRequirement this object represents. Provided by the system, the user may not set this field. |
| isCertifiedUserRequired | BOOLEAN | If true, then accessor needs to be a Synapse Certified User to gain access. |
| isValidatedProfileRequired | BOOLEAN | If true, then accessor needs to have their Synapse Profile validated to gain access. |
| isDUCRequired | BOOLEAN | If true, then accessor needs to fill, sign, and submit a Data Use Certificate (DUC) to gain access to the data. |
| ducTemplateFileHandleId | STRING | If the Data Use Certificate (DUC) is required, creator of this requirement needs to upload a Data Use Certificate (DUC) template. Users have to download this template, fill out, sign and submit it. |
| isIRBApprovalRequired | BOOLEAN | If true, then accessor needs to submit an Institutional Review Board (IRB) Approval document to gain access to the data. |
| areOtherAttachmentsRequired | BOOLEAN | If true, then accessor needs to upload attachment(s) other than Data Use Certificate (DUC) and Institutional Review Board (IRB) Approval document to gain access to the data. |
| expirationPeriod | INTEGER | After an AccessApproval is granted for this AccessRequirement, it will be expired after expirationPeriod miliseconds. Set this value to 0 to indicate that AccessApproval will never be expired. |
| isIDUPublic | BOOLEAN | If true, the Intended Data Use Statements submitted to gain access to the data will be presented to public. |
| isIDURequired | BOOLEAN | If true (default), the Intended Data Use Statement for a research project is required. |
| isTwoFaRequired | BOOLEAN | If true, then accessor needs to enable two factor authentication before gaining access to the data. |