Install Okta On-prem Connector
Early Access release
On-prem Connector is available on a subscription basis. Contact your Okta representative for more information.
Okta On-prem Connector must be installed for each on-premises app that you want to integrate with Okta. It can be installed and run on devices that meet its system requirements. See System requirements.
Before you begin
Download Okta On-prem Connector. If you've already downloaded and extracted Okta On-prem Connector as part of your app-specific connector installation, continue to the next section. Otherwise, complete the following steps:
- In the Admin Console, go to .
- Scroll to the Okta On-prem Connector section and click Download Latest for the installer for your platform.
- Copy the downloaded file (OktaOnPremConnector-<version>.zip) to the directory where you want to install Okta On-prem Connector.
- Unzip the files from the download: unzip OktaOnPremConnector-<version>.zip
You can now run the installer for On-prem Connector from this directory. The following sections describe the available installation arguments and provide some common use cases.
Command syntax
Every Okta On-prem Connector installation uses the syntax:
./opc_install.sh -token=<token> -agentName=<agent_name> [-sapJavaBinaryPath=<path_to_sap_java_connector_binaries>]
The installer runs on devices that meet the system requirements. See System requirements.
On-prem Connector installation arguments
The following table lists the available arguments for the installer.
| Argument | Description |
|---|---|
| token | This is a unique single-use installer token that's only valid for the account for which it was generated. Tokens are valid for 24 hours. Apps provide this value in different ways. See your app's integration guide for how to get this value. |
| agentName | A name for the agent. Apps provide this value in different ways. See your app's integration guide for how to get this value. |
| proxyHost | (Optional) Specify the proxy host name. |
| proxyPassword | (Optional) Specify the proxy user's password. |
| proxyPort | (Optional) Specify the proxy port number. |
| proxyUser | (Optional) Specifies the proxy's username. |
| installPath | (Optional) Specify where to install the agent. Use this if you want to install anywhere other than the default location. |
| sapJavaBinaryPath | (Required when installing On-prem Connector for SAP Netweaver ABAP) Specify the path that contains the SAP Java Connector SDK binary files. |
Use cases
The following sections provide examples of using common installation options with the On-prem Connector installer.