Authenticate and manage users

# User Service

The user service provides user account management and authentication. It includes the ability to 
send verification and password reset emails. 



User.Create

User.Delete

User.List

User.Login

User.Logout

User.LogoutAll

User.Read

User.ReadSession

User.ResetPassword

User.SendMagicLink

User.SendPasswordResetEmail

User.SendVerificationEmail

User.Update

User.UpdatePassword

User.VerifyEmail

User.VerifyToken

Create an account

Delete user account

List all users

Log a user in

Log a user out

Logout all sessions for a user

Read an account by id

Read account by username or email

Read account by email

Read a session by the session id.

Reset password

MagicLink to access your account

Hi there,

Click here to access your account $micro_verification_link

Send a Magic Link

Password reset

Hi there,
 click here to reset your password: myapp.com/reset/code?=$code

Send password reset email

Email verification

Hi there,

Please verify your email by clicking this link: $micro_verification_link

Send verification email

Update an account

Update the account password

Verify email

Verify a Token

Blank

Create

Delete

List

Login

Logout

Logout All

Read

Read Session

Reset Password

Send Magic Link

Send Password Reset Email

Send Verification Email

Update

Update Password

Verify Email

Verify Token

user

MicroAPIError

Store any custom data you want about your users in this fields.

Account

Create a new user account. The email address and username for the account must be unique.

optional user profile as map<string,string>

CreateRequest

CreateResponse

DeleteRequest

DeleteResponse

List all users. Returns a paged list of results

Maximum number of records to return. Default limit is 25.
 Maximum limit is 1000. Anything higher will return an error.

ListRequest

ListResponse

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

LoginRequest

LoginResponse

LogoutAllRequest

LogoutAllResponse

LogoutRequest

LogoutResponse

Read an account by id, username or email. Only one need to be specified.

ReadRequest

ReadResponse

Read a session by the session id. In the event it has expired or is not found and error is returned.

ReadSessionRequest

ReadSessionResponse

Reset password with the code sent by the "SendPasswordResetEmail" endpoint.

ResetPasswordRequest

ResetPasswordResponse

Your web site address, example www.example.com or user.example.com

Endpoint name where your http request handler handles MagicLink by 
 calling M3O VerifyToken endpoint. You can return as a result a success, 
 failed or redirect to another page.

Display name of the sender for the email. Note: the email address will still be 'support@m3o.com'

Text content of the email. Don't forget to include the string '$micro_verification_link' which will be replaced by the real verification link
 HTML emails are not available currently.

SendMagicLinkRequest

SendMagicLinkResponse

Send an email with a verification code to reset password.
 Call "ResetPassword" endpoint once user provides the code.

Number of secs that the password reset email is valid for, defaults to 1800 secs (30 mins)

Display name of the sender for the email. Note: the email address will still be 'noreply@email.m3ocontent.com'

Text content of the email. Don't forget to include the string '$code' which will be replaced by the real verification link
 HTML emails are not available currently.

SendPasswordResetEmailRequest

SendPasswordResetEmailResponse

email address to send the verification code

The url to redirect to after successful verification

Text content of the email. Include '$micro_verification_link' which will be replaced by a verification link

SendVerificationEmailRequest

SendVerificationEmailResponse

Session

UpdatePasswordRequest

UpdatePasswordResponse

UpdateRequest

UpdateResponse

Verify the email address of an account from a token sent in an email to the user.

VerifyEmailRequest

VerifyEmailResponse

Check 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.

Users

Downloads

Postman JSON

OpenAPI JSON