Customize API Portal user login

You can customize what API Portal page your API consumers see on first log in, and you can also enable ReCaptcha and user account locking on the login page.

Change the page displayed after first login

You can change the API Portal page users see when they first log in successfully to API Portal. The default behavior is:

  • Display the Applications page if at least one application exists
  • Display the API Catalog page if no applications exist

To change this, follow these steps:

  1. In the Joomla! Administrator Interface (JAI), click Components > API Portal > Additional Settings.
  2. In the Redirect after login field, enter a menu link (for example, /index.php?option=com_apiportal&view=home) or a menu alias (for example, /home) to redirect the user to after successful login.
  3. Click Save.

Enable ReCaptcha and user account locking

You can customize API Portal user login to display a ReCaptcha and lock the user account after a number of failed login attempts:

  1. In the JAI, click Components > API Portal > Login Protection.
  2. Click Yes to enable login protection for API Portal.
  3. Enter a value for the number of failed login attempts before a ReCaptcha is displayed.
  4. Enter a value for the number of failed login attempts before the user account is locked.
  5. Enter a value in seconds for how long the user account is locked.
  6. Click Yes to enable locking by IP address. When this setting is enabled login attempts are blocked from the same IP address for the lock time specified even if correct user credentials are entered.
  7. You can enable user account locking and IP address locking independently or in combination. For example, if you enable user account locking and IP address locking for 5 minutes after 2 failed login attempts, UserA will be locked for 5 minutes after entering 2 incorrect passwords, and any other user (for example, UserB) will also be unable to log in for 5 minutes from the same IP address, even if they provide correct user credentials.
  8. Click Save.

Related Links