Skip to main content

Password & Email

Trigger password reset flows and verify user email addresses.

See also: Password & Email documentation | Full API Reference for interactive testing and complete schemas.

Endpoints

MethodPathDescriptionReference
POST/email-verification/create-tokenCreates a token for updating/verifying a user's email address, or for registering a new user if a username is not suppliedAPI Reference →
GET/email-verification/public/public-keyGets the public key for verifying email verification tokensAPI Reference →
POST/email-verification/public/registerRegisters a new user if the token's signature can be verifiedAPI Reference →
POST/email-verification/public/send-emailPublic endpoint that sends an email containing an email verification linkAPI Reference →
POST/email-verification/public/update-emailUpdates the target user's email address if the token's signature can be verifiedAPI Reference →
GET/email-verification/public/verifyParse and verify an email verification tokenAPI Reference →
POST/email-verification/reset-keysResets the public and private keysAPI Reference →
POST/email-verification/send-emailCreates a token for verifying an email address and sends it to that email addressAPI Reference →
POST/password-reset/createCreates a password reset token and link for the given userAPI Reference →
GET/password-reset/public-keyGets the public key for verifying password reset tokensAPI Reference →
POST/password-reset/resetResets the user's password if the token is correctAPI Reference →
POST/password-reset/reset-keysResets the public and private keysAPI Reference →
POST/password-reset/send-emailSends the user an email containing a password reset linkAPI Reference →
POST/password-reset/system-setupChange admin password and set system locale, system timezoneAPI Reference →
GET/password-reset/verifyParse and verify a password reset tokenAPI Reference →