For information on the requirements for these API changes see: Rollout of the new Terms of Service and Managed Plans.
Agreeing to the ToS
Currently, clients use the following API to set that the user has agreed to the ToS: POST /termsOfUse2
Rather than add a new service, we will update the existing service’s request object as follows:
AccessToken.json
{
"title": "Access Token",
"description": "Request to agree to the terms of service.",
"properties": {
"accessToken": {
"type": "string",
"description": "An access token of the user that is agreeing to the ToS."
},
"termsOfServiceVersion": {
"type": "string",
"description": "The semantic version of the ToS that the user read and agreed to. Required. If a client does not provide this value, then a default value of '0.0.0' will be used indicating that the original (and deprecated) ToS was used."
}
}
}
The addition of the new field: termsOfServiceVersion is a backwards compatible change. If an old client calls this service without providing this new field, a default value of ‘0.0.0’ will be used to indicate that the user has agreed to the deprecated ToS. If the user attempts to set a version that is newer than the current version, an error will be returned.
We will also update the LoginResponse object returned by: POST /login2 to include the more information the user’s ToS status. The UI can use this information to show a message to the user when they need to agree to new ToS.
New ToS APIs
The following will be the new ToS APIs. These new services will be added under the “Authentication Services”
Response | URL | Request | Description | Authorization |
|---|---|---|---|---|
TermsOfServiceInfo | GET /termsOfUse2/info | none | Get information about the current ToS | Not Required |
TermsOfServiceInfo | PUT /termsOfUse2/requirements | TermsOfServiceRequirement | Sets the global ToS requirements. | Only ACT or Admin may make this call. |
TermsOfServiceStatus | GET /termsOfUse2/status | none | Get the current user’s ToS status. Used to determine if the user needs to agree to the new ToS | This call needs to work with a standard auth token in the header to identify the user but the caller does know the ID of the user yet. |
Note: The starting TermsOfServiceRequirement will be set with minimumTermsOfServiceVersion=0.0.0 and requirementDate=1/1/2011. All existing users that have agreed to the exiting ToS will meet the starting requirements. This means ACT will need to set the new requirements before users will be required.
Storage Limit APIs
We will use the following pseudo-query to determine the total number of bytes for each storage location and project combination:
SELECT PROJECT_ID, STORAGE_LOCATION_ID, SUM(FILE_SIZE_BYTES) FROM OBJECT_REPLICATION GROUP BY PROJECT_ID, STORAGE_LOCATION_ID;
Since this query can read millions of rows per project, we will cache (all containers for moves) the results for quick retrieval.
Note: While the following API will work for all combination, clients can “hard-code” the default Synapse storage location ID. The new API will be added under the “Project Setting Services”.
Response | URL | Request | Description | Authorization |
|---|---|---|---|---|
ProjectStorageUsage | GET /project/{projectId}/storage/usage | none | Get the information about all combinations for a single project. | The UserEntityPermissions.hasUpload=true for the project. “Plan managers” will have access to this. |
ProjectStorageLocationLimit | POST /project/{projectId}/storage/limit | ProjectStorageLocationLimit | Set the limit for a single combination | Only members of the “plan managers” team may call this service. |
Checking Limits Before Upload
Before a client uploads a file to a project or folder, the client will first call GET /entity/{id}/uploadDestination. We will extend the resulting UploadDestionation object to include information about the containing project and its limits. This will allow clients to block the upload of a file that would be over the limit using the following pseudo-code:
if (sumFileBytes + newFileSize > maxAllowedFileBytes) then block upload
Since we are changing the UploadDestionation object, GET /entity/{id}/uploadDestination/{storageLocationId} service will also return the new project limit information.
Model Objects
LoginResponse.json
{
"title": "LoginResponse",
"description": "Holds a session token used for short-term authentication with Synapse",
"properties": {
"sessionToken": {
"type": "string",
"description": "(deprecated) A token that identifies the user"
},
"accessToken": {
"type": "string",
"description": "A token that authorizes subsequent requests"
},
"acceptsTermsOfUse": {
"type": "boolean",
"description": "When false, the user has not agreed to the currently required version of the ToS. This user will need to agree the the latest ToS by the requirement date. True, if the user has agreed."
},
"lastAgreementDate": {
"type": "string",
"format": "date-time",
"description": "The date/time when the user last agreed to the ToS. Will be null if the user has never agreed to the ToS."
},
"lastAgreementVersion": {
"type": "string",
"description": "The version of ToS that the user last agreed to. Will be null if the user has never agreed to the ToS."
},
"authenticationReceipt": {
"type": "string",
"description": "A valid receipt allows the user to skip extra security checks."
}
}
}
TermsOfServiceInfo.json:
{
"description": "Information about the current Synapse Terms of Service (ToS).",
"properties": {
"termsOfServiceUrl": {
"type": "string",
"description": "The URL that can be used to fetch the latest ToS using an HTTPS GET."
},
"latestTermsOfServiceVersion": {
"type": "string",
"description": "The semantic version of the latest ToS in the provided URL. Callers will need to provide this version when submitting a request to agree to shown ToS."
},
"currentRequirement": {
"$ref": "org.sagebionetworks.repo.model.auth.TermsOfServiceRequirement",
"description": "Information about the global ToS Synapse requirements that all users must agree to."
}
}
}
TermsOfServiceRequirement.json
{
"description": "Information about the global ToS Synapse requirements that all users must agree to.",
"properties": {
"requirementDate": {
"type": "string",
"format": "date-time",
"description": "The date/time when the new ToS requirement will go into effect."
},
"minimumTermsOfServiceVersion": {
"type": "string",
"description": "The minimum semantic version of the ToS that all users must agree to by the provided date. Any user that has agreed to this version, or higher, will be required to agree to the latest version of the ToS after the provided date."
}
}
}
TermsOfServiceStatus.json
{
"description": "The status of a user's ToS agreement",
"properties": {
"userId": {
"type": "string",
"description": "The ID of the user."
},
"usersCurrentTermsOfServiceState": {
"$ref": "org.sagebionetworks.repo.model.auth.TermsOfServiceState",
"description": "Defines the user's current ToS state. Used to guide the UI in what the user needs to do with their ToS agreements. This will always be provided."
},
"lastAgreementDate": {
"type": "string",
"format": "date-time",
"description": "The date/time when the user last agreed to the ToS. Will be null if the user has never agreed to the ToS."
},
"lastAgreementVersion": {
"type": "string",
"description": "The version of ToS that the user last agreed to. Will be null if the user has never agreed to the ToS."
}
}
}
ProjectStorageUsage.json
{
"description": "Provides information about file allocations and limits for each storage location associated with a single project.",
"properties": {
"projectId": {
"type": "string",
"description": "The ID of the project"
},
"locations": {
"type": "array",
"items": {
"$ref": "org.sagebionetworks.repo.model.limits.ProjectStorageLocationUsage"
}
}
}
}
ProjectStorageLocationUsage.json
{
"description": "Represent the current size and limits for a single project storage location.",
"properties": {
"storageLocationId": {
"type": "string",
"description": "The ID of the storage location"
},
"sumFileBytes": {
"type": "integer",
"description": "The total number of bytes, of files, currently associated with this project storage location."
},
"maxAllowedFileBytes": {
"type": "integer",
"description": "When missing, there is not limit for this project storage location. When set, this number represent to the total number of allowed bytes for this project storage location. If the sumFileSizesBytes is greater than this value, then this project storage location is over its limit all new uploads to this project storage location will be blocked."
},
"isOverLimit": {
"type": "boolean",
"description": "When true, sumFileSizesBytes is greater than maxAllowedFileSizeBytes and all new uploads to this project storage location will be blocked."
}
}
}
ProjectStorageLocationLimit.json
{
"description": "Set the limit on the number of files bytes for a single project storage location",
"properties": {
"projectId": {
"type": "string",
"description": "The ID of the project"
},
"storageLocationId": {
"type": "string",
"description": "The ID of the storage location"
},
"maxAllowedFileBytes": {
"type": "string",
"description": "Sets the limit on the number of file bytes that can be associated with this project storage location."
}
}
}
UploadDestination.json
{
"description": "The upload destination contains information to start an upload of a file generated according to the underlying <a href=\"${org.sagebionetworks.repo.model.project.StorageLocationSetting}\">StorageLocationSetting</a>.",
"type": "interface",
"properties": {
"concreteType": {
"type": "string",
"description": "Indicates which implementation this object represents."
},
"storageLocationId": {
"type": "integer",
"description": "the unique id for the storage location, that points to the <a href=\"${org.sagebionetworks.repo.model.project.StorageLocationSetting}\">StorageLocationSetting</a>"
},
"uploadType": {
"$ref": "org.sagebionetworks.repo.model.file.UploadType"
},
"banner": {
"type": "string",
"description": "If set, the client should show this banner every time an upload is initiated"
},
"destinationProjectId": {
"type": "string",
"description": "The ID of the project where this file will be uploaded."
},
"projectStorageLocationUsage": {
"$ref": "org.sagebionetworks.repo.model.limits.ProjectStorageLocationUsage",
"description": "This object includes information about size and limits associated with this project storage location. Clients should not attempt to upload a file to this location if isOverLimit=true or if (<size_new_file> + sumFileBytes) is greater than maxAllowedFileBytes."
}
}
}
TermsOfServiceState.json:
{
"type": "string",
"description": "The user's current ToS state defines what action if any they will need to take to meet ToS requirements.",
"enum": [
{
"name": "MUST_AGREE_NOW",
"description": "The user must agree to the new ToS before they can use the service."
},
{
"name": "MUST_AGREE_SOON",
"description": "The user currently has agreed to an older ToS and they will need to agree to the new ToS before new required date."
},
{
"name": "UP_TO_DATE",
"description": "The user has agreed to the latest ToS so they are up-to-date"
}
]
}