| Table of Contents |
|---|
...
| Description | Intended User | URI | Method | Request Parameters | Request Body | Response Body | ||
|---|---|---|---|---|---|---|---|---|
Create and sendan email membership invitation. Send an email containing an invitation link to the invitee. The link will contain a serialized EmailMembershipInvitationId. | team administrator | /emailMembershipInvitation | POST | portalEndpoint | EmailMembershipInvitation | EmailMembershipInvitation | ||
| Retrieve a pending email membership invitation by ID. The emailAddress field of the response body object will be null. | authenticated user | /emailMembershipInvitation/{id} | GET | -- | -- | EmailMembershipInvitation | ||
| Retrieve all the pending email membership invitations from a Team. | team administrator | /team/{id}/emailMembershipInvitations | GET | limit, offset | -- | PaginatedResults<EmailMembershipInvitation> | ||
| Delete and invalidate a pending email membership invitation. | team administrator | /emailMembershipInvitation/{id} | DELETE | -- | -- | -- | ||
Starts Start the process of creating a new account, similarly to POST /account/emailValidation, but also the process of associating a membership invitation to the new account. Sends Send a 'validation email' message to the provided email address. The email contains will contain a link to complete the registration process. The link will contain a serialized EmailValidationSignedToken (used for new account registration) and a serialized EmailMembershipInvitationId (used to create membership invitation). Intended to be used in conjunction with POST /account. | public | /emailMembershipInvitation/{id}/account/emailValidation | POST | portalEndpoint | NewUser | -- | Send||
Verify whether the authenticated user is the invitee of the indicated EmailMembershipInvitation. If they are, the response body will contain an InviteeVerificationSignedToken. If they are not, the response body will be null and an identity verification email containing a link will be sent to the address associated with the | provided indicated EmailMembershipInvitation. The link | contains will contain a serialized InviteeVerificationSignedToken. | authenticated user | /emailMembershipInvitation/{id}/verification | POST | portalEndpoint | -- | --InviteeVerificationSignedToken |
Create a MembershipInvitation. The invitation is created from the team associated with the given email membership invitation to the currently authenticated user. At least one of the following conditions must be met in order for this service to succeed: Doesn't send any email notifications. | authenticated user | /emailMembershipInvitation/{id}/membershipInvitation | POST | InviteeVerificationSignedToken (optional) | -- | InviteeVerificationSignedToken | MembershipInvtnSubmission |
...