The OAuth Solution Kit contains the policies, endpoints, and assertions that create the OAuth Toolkit (OTK). From the Policy Manager, install the single OAuth Solution Kit .sskar file. This file contains multiple solution kits that provide specific OAuth functionality.
This page contains the following topics related to installation:
Perform the following pre-installation tasks:
Creating the database connection before installing the solution kits allows you to simply select the existing connection during the Resolve Entity Conflicts stage.
To upgrade an OTK release to the latest version, follow the upgrade instructions. If upgrading from OTK 4.x, read-only policies are replaced; custom configurations and services are retained. If upgrading from OTK 3.x, install the 4.x version and transfer custom configuration to the #policies.
Upgrading from 4.0.00 to 4.2.00 requires running an upgrade compatibility patch. The patch is available from Supporting Files.
If you prefer to completely remove your older installation and lose all customizations, perform an uninstall, delete any remaining folders, then install the new OTK version.
If you prefer to retain a previous version as a reference, install the new OTK version with an instance modifier.
This is step one of the Solution Kit Installation Wizard.
The OAuth Solution kit includes multiple solution kits.
The solution kit includes DMZ, Internal, Shared, and Persistence Layer kits.
Choose to install solution kits on the same server, or to split the OTK installation across the DMZ (external) and Internal servers.
The recommended multi-server OTK installation is as follows:
For multi-server installation instructions, see Dual Gateway Scenario.
To select and install specific solution kits on a single server:
Choose any of the following installation options:
Add an Instance Modifier to distinguish this installation from a previous installation of the same version. See Add an Instance Modifier.
Do you intend to keep the previous installation as a reference?
If so, select the solution kits and click Set Instance Modifier. Type a string value, then click OK. The value is added to service resolution URIs, folders, policy names, and other components.
Rules about instance modifiers:
If you intend to integrate with the CA API Developer Portal, do not add an Instance Modifier to your OTK installation. The CA API Developer Portal currently does not support OTK installations with Instance Modifiers.
The installer tests each solution kit for potential conflicts in the following areas:
If an error is detected in any of the solution kits:
To resolve entity conflicts:
Selection of any the following solution kits requires resolution of the database connection.
There will always be an entity conflict to resolve until the OTK database connection is identified. There is an additional database connection entity conflict to resolve if you have selected to integrate with the CA API Management SaaS Portal.
To resolve the database connection entity conflict: