Skip to contents

Represents an Organization.

Usage

Organization(name=NULL, id=NULL, created_on=NULL, created_by=NULL)

Format

An S3-style class object.

Arguments

name

(Optional[character]) The name of the organization

id

(Optional[character]) The ID of the organization

created_on

(Optional[character]) The date this organization was created

created_by

(Optional[character]) The ID of the user that created this organization

Value

NULL

Methods

  • Organization(name=NULL, id=NULL, created_on=NULL, created_by=NULL): Constructor for Organization

  • synGetAcl(instance, synapse_client=NULL): Gets the ACL for this organization

  • synGetJsonSchemas(instance, synapse_client=NULL): Gets the JSON Schemas that are part of this organization

  • synUpdateAcl(instance, principal_id, access_type, synapse_client=NULL): Updates the ACL for a principal for this organization

Examples

if (FALSE) { # \dontrun{
## Creating a JSON schema organization
    library(synapser)
    synLogin()

    org = Organization(name = "myUniqueOrgName") |> synStore()
    print(org$id)

    # List the JSON schemas in the organization
    schemas = org |> synGetJsonSchemas()

## Getting an existing JSON schema organization
    library(synapser)
    synLogin()

    org = Organization(name = "myUniqueOrgName") |> synGet()
    print(org$id)
} # }