Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejson
{
	"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."
		}
	}
}

...

TermsOfServiceState.json:

Code Block
languagejson
{
	"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"
		}
	]
}

...