| Table of Contents |
|---|
...
| New models | Existing models (modified) | ||||
|---|---|---|---|---|---|
| EmailMembershipInvitation | EmailMembershipInvitationId | EmailValidationSignedToken | InviteeVerificationSignedToken | AccountSetupInfo | NewUser |
emailAddress teamId createdBy id | emailMembershipInvitationId | timestamp hmac | inviteeId emailMembershipInvitationId timestamp hmac | firstName lastName
EmailValidationSignedToken username password |
|
...
| Description | Intended User | URI | Method | Request Parameters | Request Body | Response Body |
|---|---|---|---|---|---|---|
| Create and send email membership invitation containing an invitation link. The link will contain a serialized EmailMembershipInvitationId. | team administrator | /emailMembershipInvitation | POST | portalEndpoint | EmailMembershipInvitation | EmailMembershipInvitation |
| Retrieve pending email membership invitation by ID. | authenticated user | /emailMembershipInvitation/{id} | GET | -- | -- | EmailMembershipInvitation |
| Retrieve pending email membership invitations from a Team. | team administrator | /team/{id}/emailMembershipInvitations | GET | limit, offset | -- | PaginatedResults<EmailMembershipInvitation> |
| Delete and invalidate pending email membership invitation. | team administrator | /emailMembershipInvitation/{id} | DELETE | -- | -- | -- |
Starts 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 a 'validation email' message to the provided email address. The email contains 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 an identity verification email to the address associated with the provided EmailMembershipInvitation. The link contains a serialized InviteeVerificationSignedToken. | authenticated user | /emailMembershipInvitation/{id}/verification | POST | portalEndpoint | -- | -- |
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) | -- | MembershipInvtnSubmission |
...