Skip Navigation
Oracle Field Service Login and API domains Deprecation
Answer ID 12036   |   Last Review Date 01/27/2023

Are there any actions that I need to take to prepare for OFS Login and API Portals removal?

Oracle Field Service (OFS)
* domain
As announced in OFS 22A What's New, the and URL schemes, used as one of the options to access Oracle Field Service are deprecated and not recommended for use. Authentication requests using these domains might be served by any of Oracle data centers causing additional redirects to a data center where the target Oracle Field Service environment is running. This might result in extra latency, an increased rate of errors, and possible issues related to data residency. Review and change your current integrations and if needed, change the address to use the standard <instance_name> URL scheme. This change will improve authentication time and adhere to government and corporate policy regulations related to data residency by ensuring the request is directed to the proper data center. OFS supports two domain zones, and each environment is provided with a set of domains: the legacy (now deprecated) and the new *
Note: * is already available to customers to connect to. We highly suggest initiating the switch to * as soon as possible as the legacy * domain will no longer be supported starting version 23 D (see OFS 23A What's New). 


Below you will find the actions required in both Test and Production instance types prior to the and being removed.

User access
User access should be changed from or <instance_name> to the <instance_name> URL scheme. The instance name is defined in Your Provisioned Instances in the Cloud Portal (found on the Service Console). This would be the same name that you set up for your OFS instance. For example, if you entered "moresunshine", your URL will be "" 
If your Login Policy (i.e., SAML, OpenID) is still configured to use an outdated metadata file ('Generate metadata using (not recommended)'), you will need to change the configuration:
  1. Ensure you are on a Test instance as changes are irreversible.
  2. Under OFS Domain and Metadata, click the Download button and select the <instance_name> you will use to redirect requests from your Identity provider to the OFS environment. Download the metadata file.
  3. Upload the new metadata file to your IdP server and ensure you are able to authenticate at this instance using <instance_name>  URL scheme.
  4. Only after validating your access in Test instance continue to perform the same set of actions in production.
Login Policy > OFS Domain and Metadata > Download > 'fs'' domain is highlighted
API requests
All API requests must be sent to <instance_name> URL scheme instead of or <instance_name> The Oracle assigned Instance Name that is defined in Your Provisioned Instances in the Cloud Portal (found on the Service Console). This name begins with 'ofsc'. If the Instance Name in the Service Console is 'ofsc-1111', the API URL would be ''. Example of API request:{activityId}.
Similar to what has been announced in Oracle Field Service (OFS) Infrastructure Migration to the Oracle Cloud Infrastructure (OCI), if your network has firewall rules, email anti-relay or anti-spam measures, proxy, antivirus or other filtering, ensure the following:
  • For Incoming traffic (Customer >> Oracle): domain  * is added;
  • For the Outgoing traffic (Oracle >> Customer) the JSON file with the IP Address Ranges (see IP blocks with tag "OSN" that belongs to your OCI regions) is implemented.
Frequently Asked Questions
When can I start testing the <instance_name> URL scheme?
You can start anytime. We recommend starting as soon as possible as starting with 23 D the legacy domain will no longer be available. 
Can I continue using the <instance_name> naming convention?
You can continue using the deprecated <instance_name> only until 23D, when the * domain will be completely removed. Which is why we encourage you to initiate the switch to the standard domain * as soon as possible.
Will there be any downtime?
We do not anticipate any downtime after the * domain, Login, and API Portals removal as long as you take all measures to migrate to the <instance_name> URL scheme.
Can I refuse/cancel the removal of the API/Login Portals or the * domain?
It is not possible to refuse/cancel the removal of the API/Login Portals or the * domain.
Do we need to change the Client ID/Secret of OFS applications after we switch to <instance_name> URL scheme?
No further changes to the Client ID/Secret are required. The authentication structure stays the same as mentioned in REST API for Oracle Field Service. The only change is from the from or * to <instance_name>
Stay updated and subscribe to any future changes by using the "Notify me" button on the panel to the right.
If you have any other questions or concerns in the meantime, do not hesitate to submit a Service Request to the CX Portal or contact us directly.