Introduction

The OAuth Client is used to integrate with an external application registered with an authentication server such as Azure AD or Google. The OAuth Client will be referenced by one or more Email Connections and will be used to obtain an access token and refresh the access token when it expires.

Creating OAuth Client Records

Step 1	From the Agents & Connections navigation pane, select System > OAuth Clients. The OAuth Client list displays. Below the list, OAuth Client Details for a new OAuth Client record displays.
Step 2	Enter / select Details for a new OAuth Client, using the field descriptions below as a guide. Required fields display an asterisk ( * ) after the field name. Default values for fields, if available, display automatically. To display more of the Details fields on the screen, you can either: Use the scroll bar. Temporarily hide the list above the Details. Click the New button above the list to display a pop-up version of the Details.
Step 3	Click a Save button. The OAuth Client record is added to the database, and all buttons and tabs in the OAuth Client Details are enabled.

Note

To open an existing record on the list, either:

Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).

OMS Server Details

The following OMS Server Details is for an existing OMS Server. See the field descriptions, below, for a description of all fields that display in the OMS Server Details.

For information on how to access additional details - such as Metadata and complete database Details - for OAuth Clients (or any type of record), see Records.

OAuth Client Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the OMS Server Details.

Field Name	Description
General	This section contains detailed information about the OAuth Client.
Name	Name used within the Controller to identify this resource. Up to 40 alphanumerics. It is the responsibility of the user to develop a workable naming scheme for resources.
Description	Unable to render {include} The included page could not be found.
Member of Business Services	Unable to render {include} The included page could not be found.
OAuth Client Details
Provider	Authorization server provider. Options: Azure AD Google Other
Cluster Node Redirect URLs	The URL that the user will be redirected to after authorizing the Universal Controller application. Redirect URLs are specified as '{Universal Controller Base URL}/oauth2/callback'. For example, 'https://example.stone.branch/uc/oauth2/callback'. The Universal Controller will extract the authorization code from the request and exchange it for an access token. The redirect URLs need to match the ones used when registering the Universal Controller application with the authorization server. Specify a redirect URL for every cluster node that you need to authorize the Universal Controller application from.
Authorization Endpoint	Authorization endpoint for the authorization server. This is used by Universal Controller to obtain a temporary authorization code.
Token Endpoint	Token endpoint for the authorization server. This is used by Universal Controller to exchange the temporary authorization code for an access token. It is also used by Universal Controller to refresh the access token once it expires.
Client ID	Client identifier. This is issued by the authorization server when registering the Universal Controller application.
Client Secret	Client secret. This is issued by the authorization server when registering the Universal Controller application.
Metadata	This section contains Metadata information about this record.
UUID	Universally Unique Identifier of this record.
Updated By	Name of the user that last updated this record.
Updated	Date and time that this record was last updated.
Created By	Name of the user that created this record.
Created	Date and time that this record was created.
Buttons	This section identifies the buttons displayed above and below the OMS Server Details that let you perform various actions.
Save	Saves a new record in the Controller database.
Save & New	Saves a new OMS Server record in the Controller database and redisplays empty Details so that you can create another new record.
Save & View	Saves a new OMS Server record in the Controller database and continues to display that record.
New	Displays empty (except for default values) Details for creating a new record.
Update	Unable to render {include} The included page could not be found.
Suspend	Temporarily disconnects the OMS Server.
Resume	Resumes the connection of a Suspended OMS Server.
Delete	Unable to render {include} The included page could not be found.
Refresh	Refreshes any dynamic data displayed in the Details.
Close	For pop-up view only; closes the pop-up view of this record.
Tabs	This section identifies the tabs across the top of the OMS Server Details that provide access to additional information about the OMS Server.
Agents	Lists all Agents for which this OMS Server is the network communication provider between the Controller.
Notifications	Lists all notifications that have been defined for this OMS Server.

Starting and Stopping OMS

For instructions on starting and stopping OMS Servers, see Starting and Stopping Agent Components.

Sending Notifications on Status of an OMS Server

You can configure OMS Servers to send a notification via email or SNMP if that OMS Server status changes from Connected to Disconnected or Disconnected to Connected.

Step 1	From the Agents and Connections navigation pane, select System > OMS Servers. The OMS Servers list displays.
Step 2	Open the record of an OMS Server on the list.
Step 3	Click the Notifications tab to display a list of any Email and SNMP notifications configured for the OMS Server.
Step 4	Select the type of notification you want the OMS Server to send, and then click New. Notification Details for a new Notification displays (See Email Notification Details and SNMP Notification Details, below.
Step 5	Complete the fields as needed (see Email Notification Details Field Descriptions and SNMP Notification Details Field Descriptions, below). Note OMS built-in variables are available to pass data about the OMS Server into the notification. (User-defined variables, including Global variables, are not available for use in OMS Server email notifications.)
Step 6	Click the Save button to save the record.

Email Notification Details

Email Notification Details Field Descriptions

The following table describes the fields and buttons on Email Notification Details.

Field Name	Description
Criteria	This section contains criteria for sending the notification.
Status Options	Note If you select Disconnected, and the OMS Server status is Connected but the session status becomes Impaired, the notification will qualify and be sent. If you select Connected, and the OMS Server recovers from an Impaired session status, the notification will qualify and be sent.
Details	This section contains assorted detailed information about the notification.
Email Template	Unable to render {include} The included page could not be found.
Email Connection	Unable to render {include} The included page could not be found.
Reply-To	Unable to render {include} The included page could not be found.
To	Unable to render {include} The included page could not be found.
CC	Unable to render {include} The included page could not be found.
BCC	Unable to render {include} The included page could not be found.
Subject	Unable to render {include} The included page could not be found.
Body	Unable to render {include} The included page could not be found.
Buttons	This section identifies the buttons displayed above and below the Notification Details that let you perform various actions.
Save	Unable to render {include} The included page could not be found.
Save & New	Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.
Update	Unable to render {include} The included page could not be found.
Delete	Unable to render {include} The included page could not be found.
Refresh	Refreshes any dynamic data displayed in the Details.
Close	For pop-up view only; closes the pop-up view of this notification.

SNMP Notification Details

SNMP Notification Details Field Descriptions

The following table describes the fields and buttons on SNMP Notification Details.

Field Name	Description
Criteria	This section contains criteria for sending the notification.
Status Options	Note If you select Disconnected, and the OMS Server status is Connected but the session status becomes Impaired, the notification will qualify and be sent. If you select Connected, and the OMS Server recovers from an Impaired session status, the notification will qualify and be sent.
Details	This section contains assorted detailed information about the notification.
SNMP Manager	Unable to render {include} The included page could not be found.
Notification Severity	Unable to render {include} The included page could not be found.
Buttons	This section identifies the buttons displayed above and below the Notification Details that let you perform various actions.
Save	Unable to render {include} The included page could not be found.
Save & New	Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.
Update	Unable to render {include} The included page could not be found.
Delete	Unable to render {include} The included page could not be found.
Refresh	Refreshes any dynamic data displayed in the Details.
Close	For pop-up view only; closes the pop-up view of this notification.