invitations

Validate Invitation

Changed on

Look up a pending invitation by its token, for the accept page to render before committing.

A POST with the token in the body, not a GET with it in the URL: the token is a bearer credential, and a URL path is what an access log or an intermediate proxy routinely retains.

post/api/v1/invitations/validate

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

tokenstring required

Response

Successful Response

emailstring required
expires_atstring date-time required
needs_passwordboolean required

Whether the invited address has never signed in here, so accepting should also set its password. False when the address already has a way in, and then accept refuses one.

organization_namestring required
rolestring required

Changes