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

Download Open API Spec

Organization

org.sagebionetworks.repo.model.schema.Organization

The first step in creating new type schema in Synapse is to setup and configure an organization. The name of the organization serves as the root for each schema's $id managed by that organization. The organization name 'org.sagebionetworks' is reserved for the core Synapse model objects. Each organization also has an Access Control List (ACL) that controls who can add schemas to an organization. All schemas created under an Organization will be considered publicly readable and reference-able. Organizations are immutable

Field Type Description
id STRING The Synapse identifier issued to the Organization.
name STRING The name of the organization servers as the root for each schema's $id managed under an organization, and each name must be unique.
createdOn STRING The date this Organization was created.
createdBy STRING The ID of the user that created this Organization.