OAuth client settings

To use OAuth for sending and receiving e-mails, you need to configure OAuth client settings for both providers and Garoon.
The setting for the OAuth client can be configured in Garoon version 5.5.1 or later.

Steps to Configure OAuth to Send and Receive E-Mails
Steps:
Task by Provider Configure an OAuth client.
Configure necessary settings according to your e-mail settings.
Task to Be Performed in Garoon Configure an OAuth client.
You need a client ID and a client secret provided in Step 1.
For details, refer to how to add OAuth clients.
Task to Be Performed in Garoon Add an e-mail server.
For details, refer to "Using Gmail/Exchange Online Account" in "Setting up an E-Mail Server".
Task to Be Performed in Garoon Add a user account.
For details, refer to "User Account Settings".
Task to Be Performed in Garoon The user performs OAuth authorization.
For details, refer to how to perform OAuth authorization.

Adding OAuth Clients

Add your OAuth client.

Steps:

  1. On the provider's screen, configure OAuth client, and copy the provided client ID and the client secret to a text editor such as Notepad.

    You can find a sample configuration in the OAuth authentication page in the Support Guide.

  2. Click the administration menu icon (gear icon) in the header.

  3. Click System settings.

  4. Select "Application settings" tab.

  5. Click "E-mail".

  6. Click OAuth client settings.

  7. On the "OAuth client settings" screen, click Add. Screen capture: Adding an OAuth client on the "OAuth client settings" screen

  8. On the "Add OAuth client" screen, enter OAuth client information.

    You must provide all information about your OAuth client.

    • Display name of OAuth client:
      The display name you specify here will be shown in the drop-down list of OAuth clients on the "Add mail server" and the "Change mail server" screens.
    • Provider:
      Select a provider to use.
      You can select from the following providers.
      • Google
      • Microsoft
    • Client ID:
      Enter the client ID you copied in Step 1.
    • Client secret:
      Enter the client secret you copied in Step 1.
    Screen capture: Entering OAuth client information

  9. Confirm your settings and click Add.

Changing OAuth Clients

Change your OAuth client.

Steps:

  1. Click the administration menu icon (gear icon) in the header.

  2. Click System settings.

  3. Select "Application settings" tab.

  4. Click "E-mail".

  5. Click OAuth client settings.

  6. On the "OAuth client settings" screen, select the display name of the OAuth client you want to change.

  7. On the "OAuth client details" screen, click Change. Screen capture: Changing OAuth on the "OAuth client details" screen

  8. On the "Edit OAuth client" screen, set the fields as needed.

    For details on the fields to configure, refer to how to add OAuth clients.

  9. Confirm your settings and click "Save".

Deleting OAuth Clients

Delete your OAuth client.
You cannot delete the OAuth client configured in the e-mail server setting. Make sure you change or delete the OAuth client in the e-mail server setting before deleting it.

Steps:

  1. Click the administration menu icon (gear icon) in the header.

  2. Click System settings.

  3. Select "Application settings" tab.

  4. Click "E-mail".

  5. Click OAuth client settings.

  6. On the "OAuth client settings" screen, select the display name of the OAuth client you want to delete.

  7. On the "OAuth client details" screen, click Delete. Screen capture: Selecting the Delete action link

  8. On the "Delete OAuth client" screen, click Yes.