ACTAccessRequirement

org.sagebionetworks.repo.model.ACTAccessRequirement

JSON schema for out of band 'Access Control Team' controlled Access Requirement, a 'tier 3' Access Requirement. This access requirement directs user to contact an ACT member to gain access to the data.

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 Short optional description for the AR. Limited to 50 characters.
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.
subjectIds ARRAY<RestrictableObjectDescriptor> The IDs of the items controlled by this Access Requirement. Required when creating or updating.
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.
actContactInfo STRING Information on how to contact the Synapse ACT for access approval (external to Synapse). Required when creating or updating.
openJiraIssue BOOLEAN If true, then in addition to following directions in the 'actContactInfo' the client should open a JIRA issue to notify the ACT. If omitted, default is 'true'.