Panel | ||||
---|---|---|---|---|
|
...
Creating OAuth Client Records
Step 1 | From the Agents & Connections navigation pane, select System > OAuth Clients. The OAuth Client list displays. |
---|
Step 2 | Enter / select Details for a new OAuth Client, using the field descriptions below as a guide.
To display more of the Details fields on the screen, you can either:
|
---|---|
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:
|
...
OAuth Client Details
The following OMS Server OAuth Client Details is for an existing OMS ServerOAuth Client. See the field descriptions, below, for a description of all fields that display in the OMS Server OAuth Client 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.
...
The following table describes the fields, buttons, and tabs that display in the OMS Server OAuth Client 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 |
|
|
| |||
Member of Business Services |
|
|
| |||
OAuth Client Details | |||
---|---|---|---|
Provider |
Session Status
Authorization server provider. Options: |
- Operational - All OMS Server messaging sessions are operational.
- Impaired - Ability of OMS clients to produce and/or consume messages is impaired.
- None - OMS Server is disconnected.
If enabled, indication that the OMS Server has been Suspended (temporarily disconnected).
OMS Server, in a High Availability environment of multiple cluster nodes, that is connected to the Controller or was last connected to the Controller.
| ||||
The URL that the user will be redirected to after authorizing the Universal Controller application. Redirect URLs are specified as 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. | ||||
Authorization Endpoint | Authorization endpoint for the authorization server. This is used by Universal Controller to obtain a temporary authorization code. Read only. | |||
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. Read only. | |||
Tenant ID | If provider is Azure AD; The tenant identifier. If not specified, defaults to common. | |||
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. | |||
Scopes | The list of scopes to request access to.
| |||
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 |
OAuth Client Details that let you perform various actions. | |
Save | Saves a new record in the Controller database. |
Save & New | Saves a new |
OAuth Client 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 |
|
|
|
Resume
Resumes the connection of a Suspended OMS Server.
Temporarily disconnects the OMS Server.
Delete |
|
|
| |||
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 |
---|
OAuth Client Details that provide access to additional information about the |
OAuth Client. |
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.
...
...
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 | ||
---|---|---|
| ||
|
...
Details
...
This section contains assorted detailed information about the notification.
...
Email Template
...
Email Connection
...
Reply-To
...
To
...
CC
...
BCC
...
Subject
...
Body
...
Buttons
...
This section identifies the buttons displayed above and below the Notification Details that let you perform various actions.
...
Save
...
Save & New
...
Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.
...
Update
...
Delete
...
Refresh
...
Refreshes any dynamic data displayed in the Details.
...
Close
...
For pop-up view only; closes the pop-up view of this notification.
...
...
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 | ||
---|---|---|
| ||
|
Details
This section contains assorted detailed information about the notification.
SNMP Manager
Notification Severity
Buttons
This section identifies the buttons displayed above and below the Notification Details that let you perform various actions.
Save
Save & New
Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.
Update
Delete
Refresh
Refreshes any dynamic data displayed in the Details.
Close
Email Connections | Lists all |
Notifications
Lists all notifications that have been defined for this OMS Server.
...
For instructions on starting and stopping OMS Servers, see Starting and Stopping Agent Components.
...
Email Connections that reference this OAuth Client. Click the Details icon to view full email connection record. | |
Versions | Lists all versions of this OAuth Client. Click the Details icon to view full version record. |
Creating an Email Connection
From the Email Connections tab, You can create a new Email Connection that references this OAuth Client by clicking the icon to display details for a new Email Connection record.