authentication

User

User management and authentication

Introduction

The user service provides user account management and authentication

Features

See the features of the user service below along with related pricing details

Endpoint Description Pricing (per request)
Create Create a new user account. The email address and username for the account must be unique. Free
Delete Delete an account by id Free
Login Login 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 error Free
Logout Logout a user account Free
Read Read an account by id, username or email. Only one need to be specified. Free
Read Session Read a session by the session id. In the event it has expired or is not found and error is returned. Free
Send Verification Email Send 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: 'https://user.m3o.com/user/verify?token=a-verification-token&rediretUrl=your-redir-url' Free
Update Update the account username or email Free
Update Password Update the account password Free
Verify Email Verify the email address of an account from a token sent in an email to the user. Free

Examples

Create an account

{
    "id": "usrid-1",
    "username": "usrname-1",
    "email": "[email protected]",
    "password": "mySecretPass123"
}
{}

Visit the API page to get started.