[User management] Keycloak Email Configuration

[User management] Keycloak Email Configuration

Overview

This guide provides step-by-step instructions for configuring email sending in Keycloak.

About User Permissions

A valid destination email address is required to test the email configuration. Do not use agility-admin@b-yond.com. Instead, select another user account that has auth-admin permissions and a valid email address.

To learn how to create users with auth-admin permissions, refer to the Local Users documentation.

Accessing the Admin Console Page

There are two ways to access this page through the AGILITY user interface: via the Application Settings panel or from the top navigation bar menu. Both options will take you to the same destination—choose the one that best fits your workflow.

Application Settings

Users can access the Admin Console page from the Application Settings page within AGILITY:

  1. From the main navigation sidebar, click Applications.

    image-20250505-152744.png
    Main Navigation Menu: Application
  2. Scroll down to locate the Admin Console card.

    image-20250604-142104.png
    Applications: Admin Console Card
  3. Click the Go to Admin Console button—you’ll be redirected to the Admin Console home page.

Top Bar Menu

Users can also access the Admin Console page from the Top Navigation Bar within AGILITY:

  1. From the top navigation bar, click the More button.

    image-20250505-195815.png
  2. Locate the Admin Console from the list.

    image-20250604-143351.png
  3. Click on it to open the feature page—you’ll be redirected to the Admin Console home page.

You may be prompted to authenticate by entering your AGILITY credentials before accessing the Admin Console page.
Email settings configuration


Email Settings Configuration

  1. Navigate to ConfigureRealm Settings.

  2. Click on the Email tab.

  3. Fill out the email configuration form according to your SMTP settings (e.g., host, port, authentication, from address).

  4. Click Test Connection to validate the configuration.

  5. ✅ Ensure a green success notification appears, confirming the connection was successful (as shown in the image below).

    Confirmation Message
  6. Check the selected user's inbox to confirm the test email was received.

    image-20240614-195712.png
    Confirmation Email