Explore

Let's begin familiarizing ourselves with AuthCompanion and take a tour of the functionally.

The best way to learn something is by using it yourself - use this guide as the first stop toward a more deeper understanding.

Registering a User

AuthCompanion takes care of the user authentication for your web application. The Server comes with pre-built Web Forms to help you quickly integrate user auth alongside your web application.

With the AuthC server running, start first by registering an account using this Web Form located at: http://localhost:3002/v1/web/register

After a successful login or account registration, AuthC provides developers a user's access token like below:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyaWQiOiJxYm5qbmozcmR1dzhiZ2c3aGJ0Z25pY2kiLCJuYW1lIjoiQXV0aHkgUGVyc29uIiwiZW1haWwiOiJoZWxsb0BhdXRoY29tcGFuaW9uLmNvbSIsInVzZXJGaW5nZXJwcmludCI6IiRhcmdvbjJpZCR2PTE5JG09NjQwMDAsdD0zLHA9MSRoTEdsUGdsaWdzUG9QNW11V3BVRXF3JEphUjB3UkJNRGxiTi9qQmtKYnl3L0M0R21jU2NKM3V5bFFSRGpBVFpOVDQiLCJzY29wZSI6InVzZXIiLCJpYXQiOjE2ODg5Mjc5ODAsImV4cCI6MTY4ODkzMTU4MH0.HbGzUbg655R5af-Vxz4phhSB73vQ8-v2VOdQINqRYno

The access token is stored in LocalStorage and contains information about the user.

Decode the token's payload here to find out more about the user who registered.

Store AuthCompanion's access token in your front-end application's memory and use it to both understand 1) who the user is and 2) pass it along as an authentication method into your app's backend APIs.

Lastly, you'll want to refresh the access token with AuthCompanion's /refresh endpoint before it expires! For more information on how to best manage user sessions, check out the Integration guide!

When you're ready to use AuthC along side your frontend application, tell the Server to redirect users after they login to your application's home page (instead of the one the comes built-in with AuthCompanion).

In AuthCompanion's .env file change "APPLICATION_ORIGIN" to the URL of your application. Example:

APPLICATION_ORIGIN=http://localhost:3002/client/v1/home

Login as User

Next, log in with the account you just created using your email and password at this Web Form: http://localhost:3002/v1/web/login. You should be redirected back to the home page.

Change User's Profile

If you'd like to change your user account - that's easy to do as well, try this Web Form: http://localhost:3002/v1/web/profile.

Recover an Account

Have you forgotten your account details? Use the recovery flow Web Form to gain access to your account: http://localhost:3002/v1/web/recovery.