...
| Description | Restrictions | Intended User / Authorization | Notification sent to | URI | Method | Request Parameters | Request Body | Response Body |
|---|---|---|---|---|---|---|---|---|
Request verification.
| Can only request if there isn't already a submitted or approved request. Content must match user profile, emails, ORCID in system at the time the request is made. Rejected if required fields are blank. | any authorized user | ACT | /verificationSubmission | POST | -- | VerificationSubmission | VerificationSubmission |
| Get a list of verification submissions. | ACT | -- | /verificationSubmission | GET | limit, offset, userId, state | -- | VerificationSubmissionPaginatedResults | |
| Change submission state | Allowed state transitions shown in diagram above. | ACT | user who requested verification | /verificationSubmission/{id}/state | POST | -- | VerificationState | -- |
Get UserBundle If not self or ACT then private fields are cleared. | Public | -- | /user/{id}/userBundle | GET | -- | -- | UserBundle | |
| Link the user ID given by an oauth2 provider to a Synapse account. | any authorized user | -- | /oauth2/alias | POST | -- | OAuthValidationRequest | PrincipalAlias | |
| Unbind an alias from an account. | owner of the alias | /alias/{aliasType}/{aliasName} | DELETE | -- | -- | -- | ||
| Download attachment from verification submission. | ACT | -- | /file/{id}?fileAssociateType=VERIFICATION_SUBMISSION&fileAssociateId=999 | GET | fileAssociateType *(required) fileAssociateId (required) redirect (optional) *Note we introduce a new fileAssociateType, "VerificationSubmission". | download URL |
...
UserBundle:
- isCertified
- isVerifiedhasSignedTOU
- isACTMemberisAdmin
- userProfile (public fields for public, private fields for owner)
- ORCID
- verificationSubmission: if owner or ACT, will be the latest. Otherwise, will only be included if approved and will be scrubbed of private fields.
...