Invitations
Only works for a valid link. Marks the invitee's e-mail as verified and returns the page where they choose a password. A link can be activated once: from then on it resolves to "used", which the activation page turns into a sign-in. Once the password is set, the success page leads back to the back-office.
Request body carrying an invitation link's token.
Token from the invitation e-mail's link. A token that cannot be used is not an error, it resolves to
invalid.
Ticket created.
Where to send the invitee to choose a password.
Password-change page for the invitee. Valid for 15 minutes; redirect to it immediately.
token is missing.
The link is not currently valid.
Too many requests; retry after the delay given in Retry-After.
POST /api/invitations/activate HTTP/1.1
Host: app.neostore.cloud
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"token": "text"
}{
"ticketUrl": "text"
}Works for a valid or an expired link (state "valid" or "expired"): issues a new link, which makes every previous link invalid, and sends the "Welcome, new link" e-mail.
Request body carrying an invitation link's token.
Token from the invitation e-mail's link. A token that cannot be used is not an error, it resolves to
invalid.
A new link was issued and sent.
No content
token is missing.
The access is already activated, or the link is invalid.
Too many requests; retry after the delay given in Retry-After.
POST /api/invitations/resend HTTP/1.1
Host: app.neostore.cloud
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"token": "text"
}No content
Changes nothing, but emits the tenant's User:InvitationOpened event whenever the link resolves to a user.
Request body carrying an invitation link's token.
Token from the invitation e-mail's link. A token that cannot be used is not an error, it resolves to
invalid.
State resolved; an unusable link is a 200 with state: invalid, not an error.
What an invitation link currently means.
valid: the latest link, not expired, ready to activate. expired: the latest link has
timed out and the user has never set a password; a new link can be sent. used: the access is
already activated (the link was spent, or the user already has a password), so the page should offer
to sign in. invalid: the link cannot be used, for example because the access was removed or a
newer link has been sent.
Display name of the tenant the invitation grants access to. Null when state is invalid.
Name of the role the invitation grants on that tenant. Null when state is invalid.
The invitee's e-mail with the local part hidden, e.g. j***@brand.com, so the page can say who
the link is for without disclosing the address. Null when state is invalid.
The invitee's stored back-office language, for the page to display in. Null when none is stored or
state is invalid.
token is missing.
Too many requests; retry after the delay given in Retry-After.
POST /api/invitations/status HTTP/1.1
Host: app.neostore.cloud
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"token": "text"
}{
"state": "text",
"tenantName": null,
"role": null,
"maskedEmail": null,
"language": null
}Last updated