synSetPermissions: synSetPermissions

In Sage-Bionetworks/synapser: R Language Bindings for Synapse API

synSetPermissions

Description

Sets permission that a user or group has on an Entity. An Entity may have its own ACL or inherit its ACL from a benefactor.

Usage

synSetPermissions(entity, principalId=NULL, accessType=list("READ", "DOWNLOAD"), modify_benefactor=FALSE, warn_if_inherits=TRUE, overwrite=TRUE)

Arguments

entity	An Entity or Synapse ID to modify
principalId	Identifier of a user or group
accessType	Type of permission to be granted. One or more of CREATE, READ, DOWNLOAD, UPDATE, DELETE, CHANGE_PERMISSIONS
modify_benefactor	Set as TRUE when modifying a benefactor's ACL
warn_if_inherits	Set as FALSE, when creating a new ACL. Trying to modify the ACL of an Entity that inherits its ACL will result in a warning
overwrite	By default this function overwrites existing permissions for the specified user. Set this flag to FALSE to add new permissions nondestructively.

Value

an Access Control List object

Examples

## Not run: 
synSetPermissions("syn11705401", 273950, c("READ", "DOWNLOAD"))

## End(Not run)

Sage-Bionetworks/synapser documentation built on Feb. 7, 2024, 12:26 p.m.