OAuth access to OAS BI Publisher REST APIs

After Oracle migrates your Oracle Analytics Server (OAS) environment to Oracle Single Sign-On (SSO), use OAuth clients with the /bip.readonly or /bip.admin scope to make authenticated REST API calls to OAS BI Publisher services.

Action required for existing BI Publisher REST API integrations: If your OAS environment has already been migrated to Oracle SSO, you must review your existing BI Publisher REST API integrations and update any that do not yet use the required OAuth authentication. Complete and validate the changes in your SSO-enabled test environment, then promote the validated integration changes before the November release is deployed to your SSO-enabled production environment. Integrations that require changes will stop working if those changes are not completed when this release is deployed to the SSO-enabled environment.

Oracle Student Financial Aid adds these scopes to the service-managed administrative application in your customer tenancy. Existing OAuth clients, client registrations, and available scopes remain unchanged. This does not remove the requirement to update existing BI Publisher REST API integrations that do not yet use the required OAuth authentication.

Use /bip.readonly for integrations that require read-only BI Publisher API access. Use /bip.admin for integrations that require administrative BI Publisher API access.

Business Benefit: Provides OAuth-authenticated BI Publisher REST API access for customers using Oracle SSO, enabling institutions to maintain their reporting integrations as OAS authentication changes.

Steps to enable and configure

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.

This capability applies after your OAS environment is migrated to Oracle SSO. For existing BI Publisher REST API integrations in an SSO-enabled environment, the following integration updates are required.

  1. Identify the BI Publisher REST API integrations that connect to your SSO-enabled OAS environments, including automated report requests and report extracts.
  2. In your SSO-enabled test environment, confirm that each integration has an OAuth client with the required BIP scope. If an integration does not already have a suitable client, create a new OAuth client through your organization's existing identity-domain administration process.
  3. Configure the client to request the appropriate BIP scope for the API access your integration requires: /bip.readonly or /bip.admin.
  4. Update the integrations to obtain an OAuth access token using the configured client and use the token for supported BI Publisher REST API calls.
  5. Test the updated integrations in the test environment. Confirm that authentication succeeds and that the reports, extracts, and other BI Publisher API operations used by your institution complete successfully.
  6. After successful testing, promote the validated integration changes to production using the OAuth client and settings for that environment. Complete this work before the November release is deployed to your SSO-enabled production environment, and verify that the integrations continue to run successfully.

Tips and considerations

  • The required integration update applies to existing BI Publisher REST API integrations as well as new integrations in OAS environments that Oracle has migrated to SSO.
  • This update does not change authentication for OAS environments that continue to use legacy OAS authentication. Prepare and validate the OAuth integration changes as part of migrating those environments to SSO.
  • Existing OAuth client registrations and scopes are not changed by the addition of the BIP scopes. Review your BI Publisher integrations separately to confirm that they use the required OAuth authentication.
  • For the current required OAS SSO migration timing and related announcements, review the OAS SSO migration deadline and updates on Cloud Customer Connect. The broader SSO migration deadline does not defer the required API changes for environments already migrated to SSO.
  • For the original SSO setup and preparation guidance, review OAS Single Sign-On Integration. Use the OAuth requirements in this November feature for BI Publisher REST API authentication and the linked Cloud Customer Connect update for current migration timing.

Key resources

Access requirements

BI Publisher REST API access in an SSO-enabled OAS environment requires an OAuth client with the /bip.readonly scope for read-only access or /bip.admin for administrative access.