Skip to content

How to setup local login

Local Login

In addition to external provider integration, you can enable local login in your solution. This is done via a dedicated endpoint in the API.

Prerequisites Before Enabling Local Login

Info

Before enabling local login, ensure that you have completed the following prerequisites.

Mail Policy

Before enabling local login, you need to have the ID for the mail policy to be used for communication purposes. This email policy will, for example, be used to send the invitation email to the user. A list of policy IDs can be retrieved via the GET api/Mail/policies endpoint. For further information, check the mail documentation.

Sender Email

The sender email must be a valid email address and will appear in the recipient's email inbox.

Default Email Language

At every place where there is an option of communication with the user, there will be an optional language parameter. If that parameter is omitted, the default email language will be used. It is therefore important to have an email template in that language available in the system.

Minimum Password Length

This setting will be applied to the password creation as the minimum required length.

Authenticator provider name

Authenticator Provider name should be the company name for the solution.

In the Settings controller PUT "local-login" endpoint, by setting the value of "localLoginEnabled" to true, you enable users to use a username and password as a means to log in. Additionally, use the GET "local-login" endpoint to observe the current state of the system.

Warning

As of right now, "selfRegisteringEnabled" should be left false as it is not fully supported currently.