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.
See Also:
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
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 schema is low-privileged. It only has the CREATE SESSION
system privilege. 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 log ins into APEX_INSTANCE_PUBLIC_USER
.
After installation, the REST Administration Interface is disabled. To enable it, an instance administrator must sign in to Oracle Application Express Administration Services.
To the REST Administration Interface:
In order for REST clients to connect, an internal administrator must register the REST Client applications.
To register REST client applications:
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 REST Data Services Installation, Configuration, and Development Guide.
To view REST client details:
Remove a REST client while viewing the ORDS Client Details dialog.
To remove a REST client:
Disable the REST Administration Interface in the REST Administration Interface dialog.
To disable the REST Administration Interface: