{ "create": [ { "title": "Create an account", "run_check": true, "request": { "id": "user-1", "username": "joe", "email": "joe@example.com", "password": "Password1" }, "response": {} } ], "update": [ { "title": "Update an account", "run_check": false, "request": { "id": "user-1", "email": "joe+2@example.com", "username": "joe" }, "response": {} } ], "updatePassword": [ { "title": "Update the account password", "run_check": false, "request": { "userId": "user-1", "oldPassword": "Password1", "newPassword": "Password2", "confirmPassword": "Password2" }, "response": {} } ], "read": [ { "title": "Read an account by id", "run_check": true, "request": { "id": "user-1" }, "response": { "account": { "id": "fdf34f34f34-f34f34-f43f43f34-f4f34f", "username": "joe", "email": "joe@example.com", "created": "1623677579", "updated": "1623677579" } } }, { "title": "Read account by username or email", "run_check": true, "request": { "username": "joe" }, "response": { "account": { "id": "fdf34f34f34-f34f34-f43f43f34-f4f34f", "username": "joe", "email": "joe@example.com", "created": "1623677579", "updated": "1623677579" } } }, { "title": "Read account by email", "run_check": true, "request": { "email": "joe@example.com" }, "response": { "account": { "id": "8b98acbe-0b6a-4d66-a414-5ffbf666786f", "username": "joe", "email": "joe@example.com", "created": "1623677579", "updated": "1623677579" } } } ], "sendVerificationEmail": [ { "title": "Send verification email", "run_check": false, "request": { "email": "joe@example.com", "subject": "Email verification", "redirectUrl": "https://m3o.com", "failureRedirectUrl": "https://m3o.com/verification-failed", "textContent": "Hi there,\n\nPlease verify your email by clicking this link: $micro_verification_link", "fromName": "Awesome Dot Com" }, "response": {} } ], "sendPasswordResetEmail": [ { "title": "Send password reset email", "run_check": false, "request": { "email": "joe@example.com", "subject": "Password reset", "textContent": "Hi there,\n click here to reset your password: myapp.com/reset/code?=$code", "fromName": "Awesome Dot Com" }, "response": {} } ], "resetPassword": [ { "title": "Reset password", "run_check": false, "request": { "email": "joe@example.com", "code": "012345", "newPassword": "NewPassword1", "confirmPassword": "NewPassword1" }, "response": {} } ], "verifyEmail": [ { "title": "Verify email", "run_check": false, "request": { "email": "joe@example.com", "token": "012345" }, "response": {} } ], "delete": [ { "title": "Delete user account", "run_check": false, "request": { "id": "8b98acbe-0b6a-4d66-a414-5ffbf666786f" }, "response": {} } ], "login": [ { "title": "Log a user in", "run_check": false, "request": { "email": "joe@example.com", "password": "Password1" }, "response": { "session": { "id": "df91a612-5b24-4634-99ff-240220ab8f55", "created": "1623677579", "expires": "1623699579", "userId": "8b98acbe-0b6a-4d66-a414-5ffbf666786f" } } } ], "logout": [ { "title": "Log a user out", "run_check": false, "request": { "sessionId": "df91a612-5b24-4634-99ff-240220ab8f55" }, "response": {} } ], "readSession": [ { "title": "Read a session by the session id.", "run_check": false, "request": { "sessionId": "df91a612-5b24-4634-99ff-240220ab8f55" }, "response": { "session": { "id": "df91a612-5b24-4634-99ff-240220ab8f55", "created": "1623677579", "expires": "1623699579", "userId": "8b98acbe-0b6a-4d66-a414-5ffbf666786f" } } } ], "list": [ { "title": "List all users", "run_check": false, "request": { "offset": 0, "limit": 100 }, "response": { "users": [ { "id": "user-1", "username": "joe", "email": "joe@example.com", "created": "1637322407", "updated": "1637322407", "verified": false, "verificationDate": "0", "profile": {} }, { "id": "user-2", "username": "jane", "email": "jane@example.com", "created": "1637324407", "updated": "1637324407", "verified": false, "verificationDate": "0", "profile": {} } ] } } ], "sendMagicLink": [ { "title": "Send a Magic Link", "run_check": false, "request": { "email": "joe@example.com", "subject": "MagicLink to access your account", "textContent": "Hi there,\n\nClick here to access your account $micro_verification_link", "fromName": "Awesome Dot Com", "address": "www.example.com", "endpoint": "verifytoken" }, "response": {} } ], "verifyToken": [ { "title": "Verify a Token", "run_check": false, "request": { "token": "EdsUiidouJJJLldjlloofUiorkojflsWWdld" }, "response": { "is_valid": true, "message": "", "session": { "id": "df91a612-5b24-4634-99ff-240220ab8f55", "created": "1623677579", "expires": "1623699579", "userId": "8b98acbe-0b6a-4d66-a414-5ffbf666786f" } } } ] }