...
| Description | 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 pending 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 pending (not yet approved) verifications. | ACT | -- | /pendingVerifications | GET | -- | -- | List<VerificationSubmission> | |
| Get a single verification submission. | ACT | -- | /verificationSubmission/{id} | GET | -- | -- | VerificationSubmission | |
| Reject verification request | ACT | user who requested verification | /verificationSubmission/{id} | DELETE | --reason | -- | -- | |
| Approve verification submission | ACT | user who requested verification | /verificationSubmission/{id}/approval | POSTPUT | -- | VerificationApproval--VerificationApproval | -- | |
Retract verification (submission must be approved) | ACT | user who requested verification | /verificationRetraction | POST/verificationSubmission/{id}/retraction | PUT | -- | VerificationRetraction--VerificationRetraction | -- |
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 | |
| Download attachment from verification submission. | ACT | -- | /verificationSubmission/{id}/file/{fileHandleId} | GET | redirect | download URL |
...
- id
- userId
- createdOn
- first name
- last name
- organization ("affiliation"?)
- location
- ORCID
- email list
- attachments (fileHandleIdfileHandleIds)
- verificationApproval
- verificationRetraction
VerificationApproval:
- createdBy
- createdOn
VerificationRetraction:
- createdBy
- createdOn
- reason
UserBundle:
- isCertified
- isVerified
- hasSignedTOU
- isACTMember
- isAdmin
- userProfile
- ORCID
- verificationSubmission (if approved)
- verificationApproval (if approved)
- verificationRetraction (if retracted)