Dev Portal SMTP Email Reference

The following property reference outlines each email and email variable used by the Dev Portal to send emails to Kong Admins and Developers.

These settings can be modified in the Kong Manager under the Dev Portal Settings / Email tab. Or by running the following command:

curl http://localhost:8001/workspaces/<WORKSPACE_NAME> \
  --data "config.<PROPERTY_NAME>=off"

If they are not modified manually, the Dev Portal will use the default value defined in the Kong Configuration file.

Note: As of 0.34 the contents of the emails sent by the Dev Portal cannot be modified.

portal_invite_email

Default: on

Description: When enabled, Kong Admins will be able to invite Developers to a Dev Portal by using the “Invite” button in the Kong Manager.

Email:

Subject: Invite to access Developer Portal <WORKSPACE_NAME>

Hello Developer!

You have been invited to create a Developer Portal account at %s.
Please visit `<DEV_PORTAL_URL/register>` to create your account.

portal_access_request_email

Default: on

Description: When enabled, Kong Admins specified by smtp_admin_emails will receive an email when a Developer requests access to a Dev Portal.

Subject: Request to access Developer Portal <WORKSPACE NAME>

Hello Admin!

<DEVELOPER NAME> has requested Developer Portal access for <WORKSPACE_NAME>.
Please visit <KONG_MANAGER_URL/developers/requested> to review this request.

portal_approved_email

Default: on

Description: When enabled, Developers will receive an email when access to a Dev Portal has been approved.

Subject: Developer Portal access approved

Hello Developer!
You have been approved to access <WORKSPACE_NAME>.
Please visit <DEV PORTAL URL/login> to login.

portal_reset_email

Default: on

Description: When enabled, Developers will be able to use the “Reset Password” flow on a Dev Portal and will receive an email with password reset instructions.

When disabled, Developers will not be able to reset their account passwords.

Subject: Password Reset Instructions for Developer Portal <WORKSPACE_NAME>.

Hello Developer,

Please click the link below to reset your Developer Portal password.

<DEV_PORTAL_URL/reset?token=12345>

This link will expire in <portal_reset_token_exp>

If you didn't make this request, keep your account secure by clicking
the link above to change your password.

portal_token_exp

Default: 21600

Description: Duration in seconds for the expiration of the Dev Portal reset password token. Default 21600 is six hours.

portal_reset_success_email

Default: on

Description: When enabled, Developers will receive an email after successfully reseting their Dev Portal account password.

When disabled, Developers will still be able to reset their account passwords, but will not recieve a confirmation email.

Subject: Developer Portal password change success

Hello Developer,
We are emailing you to let you know that your Developer Portal password at <DEV_PORTAL_URL> has been changed.

Click the link below to sign in with your new credentials.

<DEV_PORTAL_URL>

portal_emails_from

Default: nil

Description: The name and email address for the ‘From’ header included in all Dev Portal emails.

Example :

portal_emails_from = Your Name <example@example.com>

portal_emails_reply_to

Default: nil

Description: The email address for the ‘Reply-To’ header included in all Dev Portal emails.

Example :

portal_emails_reply_to: noreply@example.com

Next Steps

Workspaces

Learn how to set up and configure Dev Portals within a Workspace.

Learn More →