User management and authentication


The user service provides user account management and authentication. It includes the ability to send verification and password reset emails. All data is stored in the DB service under the "users" table.

FeaturesFull documentation

EndpointDescriptionPricing (per request)
CreateCreate a new user account. The email address and username for the account must be unique.Free
DeleteDelete an account by idFree
ListList all users. Returns a paged list of resultsFree
LoginLogin using username or email. The response will return a new session for successful login, 401 in the case of login failure and 500 for any other errorFree
LogoutLogout a user accountFree
ReadRead an account by id, username or email. Only one need to be specified.Free
Read SessionRead a session by the session id. In the event it has expired or is not found and error is returned.Free
Reset PasswordReset password with the code sent by the "SendPasswordResetEmail" endoint.Free
Send Magic LinkLogin using email only - PasswordlessFree
Send Password Reset EmailSend an email with a verification code to reset password. Call "ResetPassword" endpoint once user provides the code.Free
Send Verification EmailSend a verification email to the user being signed up. Email from will be from '[email protected]', but you can provide the title and contents. The verification link will be injected in to the email as a template variable, $micro_verification_link. Example: 'Hi there, welcome onboard! Use the link below to verify your email: $micro_verification_link' The variable will be replaced with an actual url that will look similar to this: ''Free
UpdateUpdate the account username or emailFree
Update PasswordUpdate the account passwordFree
Verify EmailVerify the email address of an account from a token sent in an email to the user.Free
Verify TokenCheck whether the token attached to MagicLink is valid or not. Ideally, you need to call this endpoint from your http request handler that handles the endpoint which is specified in the SendMagicLink request.Free


Please see an example of how to get started with the user api.

For a more detailed view please see the API page

Create Request