Skip to main content

Configure Email authentication with Sendgrid

Introduction

This page is dedicated to providing you with valuable resources to help you configure an authentication method based on the email provider you choose. Authentication is an essential security measure that verifies the identity of users and ensures that only authorized individuals have access to sensitive information.

In order to follow this guide, you will need an email provider. If you want to know how to configure your email provider, please follow this link.

Sendgrid

  • Administration panel

When you are using Sendgrid, once logged in, you will be automatically redirected to the administration panel dashboard.

Sendgrid - SMTP Credentials Panel
Sendgrid - SMTP Credentials Panel

You will need to navigate to Settings > API Keys and click on Create API Key.

  • Create your SMTP Credentials

When creating a new API key, you can give it a name that's easy for you to remember, such as "Passbolt". SendGrid will then generate a unique API key consisting of 70 random characters. This key can be used to authenticate your email sending requests through the SendGrid SMTP servers.

After generating the API key, you can use the settings shown to configure your email client or application. The SMTP username should be "apikey". The SMTP password is the API key that you generated in the previous step.

Sendgrid - SMTP Credentials
Sendgrid - SMTP Credentials

It's important to keep your SendGrid API key secure, as it can be used to access your SendGrid account and send emails from your account. You should never share your API key with anyone, and you should take steps to protect your account from unauthorized access.

  • Authentication on Passbolt GUI

On your Passbolt instance, you can navigate to Administration > Email server.

Passbolt - Email authentication
Passbolt - Email authentication

You will need to fill in your smtp credentials to match your authentication method (username & password).

  • Test your configuration

Before saving your configuration, you will need to test it in order to avoid any issues. it should pass and give the results shown below.

Passbolt - Email test success
Passbolt - Email test success
  • Save your configuration

If everything went as expected, do not forget to save your configuration and "Success: The SMTP settings have been saved successfully" should appear.