Versions Compared

Key

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

...

DescriptionIntended User / AuthorizationNotification sent toURIMethodRequest ParametersRequest BodyResponse 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.

any authorized userACT/verificationSubmissionPOST--VerificationSubmissionVerificationSubmission
Get a list of pending (not yet approved) verifications.ACT--/pendingVerificationsGET----List<VerificationSubmission>
Get a single verification submission.ACT--/verificationSubmission/{id}GET----VerificationSubmission
Rescind Reject verification requestACT--user who requested verification/verificationSubmission/{id}DELETE------
Approve verification submissionACTuser who requested verification/verificationSubmission/{id}/approvalPOST--VerificationApprovalVerificationApproval
Retract verificationACTuser who requested verification/verificationRetractionPOST--VerificationRetractionVerificationRetraction

Get UserBundle

If not self or ACT then private fields are cleared.

Public--/user/{id}/userBundleGET----UserBundle
Add ORCID to accountLink the user ID given by an oauth2 provider to a Synapse account.any authorized user --/authoauth2/orcidaliasPOST--

OAuthValidationRequest

ORCIDPrincipalAlias
Download attachment from verification submission. ACT --/verificationSubmission/{id}/file/{fileHandleId} GETredirect  download URL

 

VerificationSubmission:

  • id
  • userId
  • createdOn
  • first name
  • last name
  • organization ("affiliation"?)
  • location
  • ORCID
  • email list
  • attachments (fileHandleId

VerificationApproval:

  • createdBy
  • createdOn

VerificationRetraction:

  • createdBy
  • createdOn

UserBundle:

  • isCertified
  • isVerified
  • hasSignedTOU
  • isACTMember
  • isAdmin
  • userProfile
  • ORCID
  • verificationSubmission (if approved)
  • verificationApprovalverificationApproval (if approved)
  • verificationRetraction (if retracted)