Documentation Center

Disabling OAuth authentication

SDL strongly recommends against disabling OAuth authentication, especially in a production environment. OAuth authentication is set up to work out of the box, so only disable it if you have a pressing reason to do so. OAuth authentication must be switched on everywhere, or switched off everywhere.

Procedure

  1. In the configuration location of every Content Delivery microservice, open cd_ambient_conf.xml, the Ambient Data Framework configuration file, for editing.
  2. In each file, in the Security element, set OAuthEnabled to false, and ensure that the Rules element has an Enabled attribute set to false.
  3. Repeat until you have disabled OAuth and rules in all Content Delivery microservices.
  4. In the configuration location every Content Delivery Java/JSP client or API, open cd_client_conf.xml, the client configuration file, for editing.
  5. In each file, comment out the TokenService element, then save and close cd_client_conf.xml.
  6. Repeat until you have commented out the Token Service element in all Content Delivery Java/JSP clients and APIs.
  7. In the configuration location every Content Delivery .NET client or API, open Web.config, the Web application definition file, for editing.
  8. In each file, find the add element that has its key attribute set to oauth-enabled and set its value attribute to false. Then save and close Web.config.
  9. Repeat until you have commented out the Token Service element in all Content Delivery .NET clients and APIs.
  10. If you use UGC, in the UGC Community Service's configuration location, open cd_ambient_conf.xml for editing and uncomment the following fragment:
    <WhiteList>
      <IPAddresses>
        <Ip>0.0.0.0-255.255.255.255</Ip>
      </IPAddresses>
    </WhiteList>
  11. Save and close cd_ambient_conf.xml.
  12. Restart the Discovery Service:
    1. If the Discovery Service runs as a Windows service from the Start menu, enter services.msc to open your Services screen, find the item called SDL Web Discovery Service, right-click it and select Restart from the context menu.
    2. If the Discovery Service runs as a Java process, find the process (listed as Java (TM) Platform SE binary in Windows Task Manager) and restart it.
  13. Restart all other microservices, which are identifiable by the following Windows service names:
    • SDL Web Monitoring Service
    • SDL Web Cache Service
    • SDL Web UGC Community Service
    • SDL Web UGC Moderation Service
    • SDL Web Content Service
    • SDL Web Deployer Service
    • SDL Web Session Preview Service
    • SDL Web Session Content Service
    • SDL Web Context Service
    • SDL Web Contextual Image Delivery Service
  14. Restart all clients and APIs.