| Table of Contents |
|---|
...
Models to implement or modify
| New models |
|---|
| EmailMembershipInvitation | EmailMembershipInvitationSignedToken | EmailMembershipInvitationsResponse | EmailValidationSignedToken | AccountCreationToken | InviteeVerificationSignedToken |
inviteeEmail |
teamId |
teamId
createdBy id | emailMembershipInvitationId timestamp hmac | results - ARRAY<EmailMembershipInvitation> nextPageToken | timestamp hmac | emailValidationSignedToken emailMembershipInvitationSignedToken (optional) | inviteeId emailMembershipInvitationId timestamp hmac |
| Existing models (modified) | |
|---|---|
| AccountSetupInfo | NewUser |
firstName lastName
emailValidationSignedToken username password |
EmailMembershipInvitationSignedToken (optional) |
Services to implement or modify
| Existing or new | Description | Intended User | URI | Method | Request Parameters | Request Body | Response Body |
|---|---|---|---|---|---|---|---|
| New | Create an email membership invitation. Send an email containing an invitation link to the invitee. The link will contain a serialized EmailMembershipInvitationSignedToken. | team administrator | /emailMembershipInvitation | POST | portalEndpoint | EmailMembershipInvitation | EmailMembershipInvitation |
New | Retrieve all the email membership invitations from a Team. | team administrator | /team/{id}/emailMembershipInvitations | GET | nextPageToken | -- | EmailMembershipInvitationsResponse |
| New | Retrieve an email membership invitation. | signed token holder | /emailMembershipInvitation/{id} | GET | -- | EmailMembershipInvitationSignedToken | EmailMembershipInvitation |
| New | Delete an email membership invitation. | team administrator | /emailMembershipInvitation/{id} | DELETE | -- | -- | -- |
| Existing | Start the process of creating a new account, and optionally also the process of associating a membership invitation to the new account. Send a 'validation email' message to the provided email address. The email will contain a link to complete the registration process. The link will contain a serialized EmailValidationSignedToken (used for new account registration) and a serialized EmailMembershipInvitationSignedToken (used to create membership invitation)AccountCreationToken. Intended to be used in conjunction with POST /account. | public | /account/emailValidation | POST | portalEndpoint | NewUser | -- |
| New | Verify whether the inviteeEmail of the indicated EmailMembershipInvitation is associated with the authenticated user. If it is, the response body will contain an InviteeVerificationSignedToken. If it is not, the response body will be null and an identity verification email containing a link will be sent to the inviteeEmail of the indicated EmailMembershipInvitation. The link will contain a serialized InviteeVerificationSignedToken. | authenticated user | /emailMembershipInvitation/{id}/verification | POST | portalEndpoint | -- | InviteeVerificationSignedToken |
| New | Create a MembershipInvitation. The invitation is created from the team associated with the given email membership invitation to the currently authenticated user. A valid InviteeVerificationSignedToken must have an inviteeId equal to the id of the authenticated user and an emailMembershipInvitationId equal to the id in the URI. Doesn't send any email notifications. | authenticated signed token holder | /emailMembershipInvitation/{id}/membershipInvitation | POST | -- | InviteeVerificationSignedToken | MembershipInvtnSubmission |
...
Models to implement or modify
| New | modelsExistingmodels | ||||||
|---|---|---|---|---|---|---|---|
| MembershipInvtnSignedToken | EmailValidationSignedToken | InviteeVerificationSignedToken | MembershipInvtnSubmission | AccountSetupInfoAccountCreationToken | NewUser | ||
membershipInvitationId timestamp hmac | timestamp hmac | inviteeId membershipInvitationId timestamp hmac | emailValidationSignedToken membershipInvtnSignedToken (optional) | ||||
| Existing models (modified) | ||
|---|---|---|
| MembershipInvtnSubmission | AccountSetupInfo | NewUser |
createdOn message id createdBy expiresOn inviteeId teamId inviteeEmail | firstName lastName
emailValidationSignedToken username password |
membershipInvtnSignedToken (optional) |
Services to implement or modify
| Existing or new | Description | Intended User | URI | Method | Request Parameters | Request Body | Response Body |
|---|---|---|---|---|---|---|---|
| Existing | Create a membership invitation. The team must be specified. Either an inviteeId or an inviteeEmail must be specified. If an inviteeEmail is specified, send an email containing an invitation link to the invitee. The link will contain a serialized MembershipInvtnSignedToken. | team administrator | /membershipInvitation | POST | acceptInvitationEndpoint (optional) notificationUnsubscribeEndpoint (optional) | MembershipInvtnSubmission | MembershipInvtnSubmission |
| Existing | Retrieve a membership invitation. | signed token holder | /membershipInvitation/{id} | GET | -- | MembershipInvtnSignedToken | MembershipInvtnSubmission |
Existing | Start the process of creating a new account, and optionally also the process of associating a membership invitation to the new account. Send a 'validation email' message to the provided email address. The email will contain a link to complete the registration process. The link will contain a serialized EmailValidationSignedToken (used for new account registration) and optionally, a serialized MembershipInvtnSignedToken (used to associate membership invitation)AccountCreationToken. Intended to be used in conjunction with POST /account. | public | /account/emailValidation | POST | portalEndpoint | NewUser | -- |
| New | Verify whether the inviteeEmail of the indicated MembershipInvitation is associated with the authenticated user. If it is, the response body will contain an InviteeVerificationSignedToken. If it is not, the response body will be null and an identity verification email containing a link will be sent to the inviteeEmail of the indicated MembershipInvitation. The link will contain a serialized InviteeVerificationSignedToken. This call will only succeed if the indicated MembershipInvitation has a null inviteeId and a non null inviteeEmail. | authenticated user | /membershipInvitation/{id}/verification | POST | portalEndpoint | -- | InviteeVerificationSignedToken |
New | Set the inviteeId of a MembershipInvitation. A valid InviteeVerificationSignedToken must have an inviteeId equal to the id of the authenticated user and an membershipInvitationId equal to the id in the URI. This call will only succeed if the indicated MembershipInvitation has a null inviteeId and a non null inviteeEmail. | authenticated signed token holder | /membershipInvitation/{id}/inviteeId | PUT | -- | InviteeVerificationSignedToken | MembershipInvtnSubmission |
...