Configuring a REST API credential for sending emails using OAuth2.0 authentication
WhatsUp Gold now offers OAuth 2.0 as an updated, more secure option for authenticating emails originating from WhatsUp Gold. To use OAuth 2.0 as your preferred authentication method, you'll need to:
- Register WhatsUp Gold as a client application with Microsoft Azure
: The procedure steps applicable to registering the application with Microsoft Azure are performed outside of WhatsUp Gold. They are deemed to be accurate at the time of the v22.1 release.
- Create a REST API credential that uses OAuth 2.0 as its Auth Type, Authorization Code as its Grant Type, as well as additional information obtained during registration with Azure.
- Configure/Update your default email settings in WhatsUp Gold.
- Update existing discovery email settings, email actions, and scheduled reports set up to send emails.
To register WhatsUp Gold with Azure:
- Open an internet browser and navigate to the App registrations page in Microsoft Azure.
- Click .
- Enter a for the application you are registering.
- Select as the Supported account type.
- For Redirect URI, select Web from the Select platform drop-down menu and enter http://localhost/NmConsole/OAuth2/Permissions or https://<host>:<port>/NmConsole/OAuth2/Permissions as the URI .
: Exchange Online requires the usage of HTTPS for Redirect URIs if you are not using localhost.
- Click . This launches a new page displaying information about your new application.
- Click .
- Click the icon to the right of Microsoft Graph / User.Read, then select .
- Click .
- Click .
- Click .
- Use the applicable checkboxes at left to enable the email and offline_access permissions under the Openid permissions heading as well as the SMTP.Send permission under the SMTP heading.
- Click .
- Click .
- Click .
- Enter a description for the new client secret in the field provided.
- Select an expiration time frame for the new client secret from the drop-down list.
- Click Add
- Select and copy the for the Client secret generated by Microsoft Azure.
: The Client secret Value can only be viewed immediately after it has been generated. Retain this Value prior to exiting the Certificates & secrets page.
To create a REST API credential for sending emails using OAuth2.0 authentication:
- Return to WhatsUp Gold, then select from the main menu to launch the Credentials Library.
- Click the icon, then select from the list of credential types that appears. This launches the Add REST API Credential configuration dialog.
- First, provide a and for your new credential.
- Select OAuth2.0 as the .
- Select Authorization Code as the .
- Return to your application Overview page in Microsoft Azure, then select .
- Copy the and the , return to WhatsUp Gold, then paste the endpoints in their respective fields in the REST API Credential configuration dialog.
- Copy the , return to WhatsUp Gold, then paste it in the field in the REST API Credential configuration dialog.
- Enter the client secret Microsoft Azure generated when registering the application in the field.
- Enter offline_access https://outlook.office.com/SMTP.Send in the field. (This represents the API permissions you previously specified for the application in Microsoft Azure.)
- Click . This launches a Microsoft authorization dialog.
- When prompted, select a user account, then click to grant the specified permissions.