Table of Contents

Search

  1. Preface
  2. Process Console Introduction
  3. Home
  4. Monitor
  5. Catalog, Reports, and Custom Faults
  6. Admin
  7. OAuth 2.0 Authentication

Administration Console

Administration Console

Configuring Email Service with OAuth 2.0 Authentication

Configuring Email Service with OAuth 2.0 Authentication

Complete the following steps to register an application and configure permissions for sending emails using OAuth 2.0 in ActiveVOS:

Step 1. Register the Application

Registering for Gmail
  1. Go to Google Cloud Console.
  2. Create a new project or select an existing one.
  3. Enable the
    Gmail API
    .
  4. Go to
    APIs & Services
    >
    Credentials
    .
  5. Go to
    Create Credentials
    >
    OAuth client ID
    .
  6. Configure the OAuth consent screen with app name and scopes.
  7. Set redirect URIs. For example: https://yourapp.com/activevos/oauth2callback.
  8. Save the Client ID and Client Secret from your OAuth 2.0 Client.
  9. Use the following endpoints for authorizing users and requesting access tokens:
Registering for Microsoft Outlook
  1. Go to
    Azure Portal
    .
  2. Go to
    Azure Active Directory
    >
    App registrations
    .
  3. Select
    New Registration
    .
  4. Enter the app name and specify redirect URI.
  5. Complete registration and note down the Application client ID and Directory tenant ID.
  6. Under
    Certificates & secrets
    , create a client secret.
  7. Under
    API permissions
    , add the relevant Microsoft Graph API permissions:
    • Mail.Send
    • Mail.ReadWrite
    • offline_access
      (to enable refresh tokens)
  8. Note the Authorization URL (OAuth 2.0 authorization endpoint v2) and Token URL (OAuth 2.0 token endpoint v2) for later OAuth configuration.

Step 2. Whitelist Required Hosts

To ensure proper OAuth functionality, add all required hosts to the whitelist configuration.
Tomcat
:
<Tomcat folder>\webapps\active-bpel\WEB-INF\classes\aeEngineConfig.xml
JBoss
:
<JBoss folder>\standalone\deployments\ave_jboss.ear\active-bpel.war\active-bpel.war\WEB-INF\classes\aeEngineConfig.xml
Verify that the following URLs are included in the whitelistHosts property:
  • Authorization URL
  • Token URL
  • Email service host. For example: outlook.office365.com or smtp.gmail.com.

Step 3: Configure Email Service in ActiveVOS

After the OAuth 2.0 configuration completes, make sure to note the following values:
  • Authorization URL
  • Token URL
  • Client ID
  • Client Secret
  1. Log in to the
    ActiveVOS Console
    .
  2. Go to
    Admin Page
    >
    Configuration Services
    >
    Email Service
    .
  3. In the
    Authentication Type
    list, select
    OAuth
    .The following image displays the Email Service configuration in ActiveVOS: Configuring email service in ActiveVOS
  4. Configure the following settings:
    • Host
      :
      For Microsoft: Enter host as outlook.office365.com
      For Google: Enter host as smtp.gmail.com
      Contact your email provider administrator to confirm the correct host.
    • Port
      :
      Enter the port as
      587
      for both Microsoft and Google.
      Contact your email provider administrator to confirm the correct host.
    The following image displays the OAuth configuration details: OAuth Configuration
  5. Enter the following OAuth Credentials:
    • Sender email address
    • Client ID
    • Client Secret
    • Authorization and Token URLs
  6. Click
    Authorize
    .
    The screen redirects to the respective email provider’s authorization page. Enter your credentials or passcode to complete the authorization process.
  7. To validate the email service configuration after successful authorization, click
    Update and Test
    .
  8. Provide a recipient email address to test the setup.

0 COMMENTS

We’d like to hear from you!