Comment on page
On the backend of your Dittofi application, endpoints can be configured to only accept connections from authenticated users. This has the effect of needing users to enter login details to access certain information or functionality within your software application.
In this tutorial we will learn how to build an endpoint, action & event to login a user to our backend. We will learn about:
- 1.Authentication profiles
- 2.Custom models
- 3.Login endpoints
- 4.Login action & event
- 5.Testing the configuration
- 6.Password protected endpoints
For the purpose of this tutorial we will use a Users Data Model that looks like the following.
To kick off building a login event, the first thing that we need to do is to create an authentication profile. To do this, go to the authentication which is under the tools tab on the left hand side of the page.
This brings up the authentication profiles page.
From within here, you can add a new authentication profile by pressing "+ New Authentication Profile" in the top right of the screen.
This brings up the following screen, where you can create a new authentication profile.
The new authentication profile has the following options:
To setup a basic login with a username & password from our Users table, we can setup the Authentication Profile as below & press Save.
Next, let's take a look at the Custom Models tab. This is under the tools bar on the left hand side.
Selecting this brings up the Custom Models page.
Inside this view, we can use custom data structures to pass data around the backend of the Dittofi system. We are using this now, rather than a Model,
To see what this means in practice, click the "+ New Custom Model" in the top right hand corner of the screen & select the "New Model" option.
This brings up the following window which is split into two parts: Custom models naming & Custom Attributes.
First, we add a label & name on the left hand side of the screen. Make sure that this is set to something meaningful. In our case we set "UsernameAndPassword", since we will want our Custom Model to hold values for the Username & Password properties.
Next, we give attributes to our Custom Model. These attributes will be used to hold the values for our users username & password when they sign up.
To add the attributes, press the "+ Add Attribute" button on Custom Attributes side of the page.
Next we add two attributes of Kind Text. These attributes will store our Username & Password.
We can then save our Custom Model & go to the Endpoints tab to configure our Login endpoint.
To add a login endpoint press "+ New Endpoint" & select "New Endpoint"
We can then configure our endpoint as below.
Notice that the Request Method is set to Post & the Body Variable is of Kind Custom Model & uses the custom model that we created on our Custom Models section. The configuration for the Body Variable is shown below.
As always, the endpoint by itself does nothing. The endpoint is simply used to trigger an associated login action. To configure our login action, go to the actions tab, press "+ New Action" & give your action a name.
Next, we link our login action to our login endpoint.
Lastly, we save our action.
Using the actions & events graph on the right had side of the screen, we can then add an event of Kind Login web user.
Next we fill in the Login web user event options using (A) the basic login authentication profile that we created in the first step & (B) the Custom Model that we created in the second step.
Notice that the values for the Username & Password fields that are set in our variable browser are passed in from our endpoints body variable. Lastly save your event & close it.
The final step in setting up the action is to pick a Response Variable. This step is not mandatory, but it will allow your action to return some information to your endpoint. In this case, we are going to pick our Event variable CurrentUserToLogin. This variable holds the value we set it to inside our Login web user event.
To test the configuration, you'll need to enter a username & password into your Users Data Model. You can then generate your code, open up your endpoint & run it, entering in the username & password that you set in your Data Model.
Notice that the response variable from our action back to our endpoint contains the data CurrentUserToLogin data. This is because we configured our action to return the variable set in our event.
Now that you have a method to login a user, you can make certain endpoints password protected. For the purpose of this example, we have created two new endpoints:
- A get many records endpoint that has been configured to retrieve data from our users table
- A log out user endpoint, action & event.
Let's suppose that we want to allow users to access the Get Many endpoint, only if they are logged in. To do this, open the Get Many endpoint & set the authentication profile for the endpoint to "basic login".
Running the logout endpoint first, we check that our user is logged out. Next, we attempt to run the Get Many endpoint.
We get a 401 error code & the JSON response reads "error" : "e_unauthorized".
Notice, if we re-run our login endpoint & correctly login with a correct username & password, & then re-run our "Get Many" endpoint. This now returns success.