3.5.5 Using the REST Administration Interface to View Usage Statistics
The REST Administration Interface enables Instance administrators to automatically fetch usage metrics for an Oracle Application Express instance with a REST client.
Tip:
The REST Administration Interface requires Oracle REST Data Services (ORDS) release 3.0.5 or later.
- About the REST Administration Interface
To use the REST Administration Interface, you first register a REST client application and then review client details to obtain an access token following the OAuth Client Credentials authentication flow. - Enabling the REST Administration Interface
After installation, the REST Administration Interface is disabled. To enable it, an instance administrator must sign in to Oracle Application Express Administration Services. - Registering REST Client Applications
In order for REST clients to connect, an internal administrator must register the REST Client applications. - Viewing REST Client Details
View REST client details in the REST Administration Interface dialog. - Removing a REST Client
Remove a REST client while viewing the ORDS Client Details dialog. - Disabling the REST Administration Interface
Disable the REST Administration Interface in the REST Administration Interface dialog.
See Also:
-
"Tutorial: Protecting and Accessing Resources" in Oracle REST Data Services Installation, Configuration, and Development Guide to learn more about using OAuth flow features
-
"Using REST Administration Interface API" in Oracle Application Express API Reference
Parent topic: Managing Instance Settings
3.5.5.1 About the REST Administration Interface
To use the REST Administration Interface, you first register a REST client application and then review client details to obtain an access token following the OAuth Client Credentials authentication flow.
To provide the REST administration interface, Oracle Application Express creates the
database user APEX_INSTANCE_ADMIN_USER
during installation. This
low-privileged schema only has the CREATE SESSION
system privilege and
is locked after installation. To use the REST Administration Interface, the
APEX_INSTANCE_ADMIN_USER
user must first be unlocked. The service
modules for the REST administration interface are being stored in the
APEX_INSTANCE_ADMIN_USER
schema. Oracle does not require or
recommend direct logins into APEX_INSTANCE_ADMIN_USER
.
3.5.5.2 Enabling the REST Administration Interface
After installation, the REST Administration Interface is disabled. To enable it, an instance administrator must sign in to Oracle Application Express Administration Services.
To enable the REST Administration Interface:
- Unlock the
APEX_INSTANCE_ADMIN_USER
database user in the APEX database. - Sign in to Oracle Application Express Administration Services.
- Click Manage Instance.
- Under Instance Settings, click REST Administration Interface.
- In the REST Administration Interface dialog, click Enable Services.
3.5.5.3 Registering REST Client Applications
In order for REST clients to connect, an internal administrator must register the REST Client applications.
To register REST client applications:
3.5.5.4 Viewing REST Client Details
View REST client details in the REST Administration Interface dialog.
Developers can use REST Client Details to obtain an access token following the OAuth Client Credentials authentication flow.
Tip:
To learn more about using OAuth flow features, see "Tutorial: Protecting and Accessing Resources" in Oracle REST Data Services Installation, Configuration, and Development Guide.
To view REST client details:
3.5.5.5 Removing a REST Client
Remove a REST client while viewing the ORDS Client Details dialog.
To remove a REST client:
3.5.5.6 Disabling the REST Administration Interface
Disable the REST Administration Interface in the REST Administration Interface dialog.
To disable the REST Administration Interface:
- Sign in to Oracle Application Express Administration Services.
- Click Manage Instance.
- Under Instance Settings, click REST Administration Interface.
- In the REST Administration Interface dialog, click Disable Services or Disable Services and Remove Clients.