Creating Authentication Endpoints

Step-by-Step Guide

1. Navigate to API Tab:

   • Go to the API tab in your Twidget dashboard.

2. Create New Endpoints:

   • Click on the Create Endpoints button located at the top right corner.

3. Select Authentication:

   • In the newly opened sidebar, select Authentication. This will enable various authentication endpoints.

Prerequisite

Before creating authentication endpoints, ensure you have an authentication table set up. This table will store all user and authentication data.

• Select Authentication Table: Choose the authentication table where user and auth data will be stored.

• Set Starting Path: Define the base path you want to prepend to all the endpoints.

Available Authentication Endpoints

Once the authentication option is selected, you will see the following 7 endpoints ready to be generated:

1. /auth/signup: Endpoint for user signup.

2. /auth/login: Endpoint for user login.

3. /auth/me: Retrieve user details.

4. /auth/logout: Invalidate the current authentication token.

5. /auth/update-password: Update the user's password.

6. /auth/forgot-password: Send password reset key via email.

7. /auth/reset-password: Update the password using the reset key.

   

Each authentication endpoint comes pre-configured with necessary inputs, outputs, and command steps required to accomplish its task. However, you can edit these configurations as per your requirements.

Customer login and password recovery commands

When building or updating your own account workflows, use Customer Login, Request Customer Password Reset, Reset Customer Password and Change Customer Password with your authentication table.

The reset-request command gives a generic success response so the page does not reveal whether an email is registered. Ask the customer to check their email. The reset command takes the email, reset key and new password; reset keys expire and can only be used once.

Use Change Customer Password for an authenticated customer, supplying their current password and the new password. Take the customer ID from the signed-in customer rather than letting the form choose whose password changes. After a successful password reset or change, existing sessions are revoked and the customer must sign in again.

Test successful recovery, a wrong or expired key, a reused key and an incorrect current password using sample accounts. Keep password and reset-key values out of your page responses and shared examples.

Signup, logout and independent sessions

Newly generated signup and logout workflows use Customer Signup and Customer Logout. Their existing paths and response formats remain available. Existing saved workflows are preserved.

Use Create Customer Session when you want independent logins on multiple devices. The Authentication page lets you suspend or resume a customer and revoke sessions. Follow Customer authentication tools for setup, limits and testing guidance.